OWLNext    7.0
Borland's Object Windows Library for the modern age
Loading...
Searching...
No Matches
ocf::TOleView Class Reference

The OLE2 window view class. Used as a view in doc/view model. More...

#include <ocf/oleview.h>

Inheritance diagram for ocf::TOleView:
ocf::TOleWindow owl::TView owl::TWindow owl::TEventHandler owl::TStreamableBase owl::TEventHandler owl::TStreamableBase

Public Member Functions

 TOleView (owl::TDocument &doc, owl::TWindow *parent=0)
 Constructs a TOleView object associated with the given document object (doc) and parent window (parent).
 
 ~TOleView ()
 Destroys the TOleView object and detaches the view from the associated document.
 
auto GetViewName () -> LPCTSTR override
 Overrides TView's virtual GetViewName function and returns the name of the class (TOleView).
 
auto GetWindow () -> owl::TWindow *override
 Overrides TView's virtual GetWindow function and returns the TWindow instance associated with this view.
 
auto SetDocTitle (LPCTSTR docname, int index) -> bool override
 Overrides TView's and TWindow's virtual SetDocTitle function and stores the title of the document associated with this view.
 
auto OleShutDown () -> bool override
 Shuts down the associated OCF partners if possible.
 
auto CanClose () -> bool override
 A view uses this function to verify whether or not it can shut down.
 
- Public Member Functions inherited from ocf::TOleWindow
 TOleWindow (owl::TWindow *parent=0, owl::TModule *module=0)
 Constructs a TOleWindow object associated with the specified parent window and module instance.
 
 ~TOleWindow ()
 Checks to see if there are any open views, and, if no open views exist, destroys the TOleWindow object.
 
TOcDocumentGetOcDoc ()
 Returns the ObjectComponents document associated with this window.
 
TOcViewGetOcView ()
 Points to the ObjectComponents container view associated with this window.
 
TOcRemViewGetOcRemView ()
 Returns the server's view associated with this window.
 
TOcAppGetOcApp ()
 Returns the ObjectComponents application associated with this window.
 
bool HasActivePart ()
 Returns true if the container's view holds an in-place active embedded object.
 
bool SelectEmbedded ()
 Selects the embedded object and returns true to indicate that the object has been selected.
 
bool IsOpenEditing () const
 Checks whether the window is in Open-Edit mode.
 
bool IsRemote () const
 Returns true if the window represents an embedded server.
 
virtual void SetupDC (owl::TDC &dc, bool scale=true)
 Determines the viewport's origin and extent (the logical coordinates and the size of the device context).
 
TOcPartInsertObject (TOcInitInfo &initInfo, owl::TRect *pos=0)
 
TOcPartInsertObject (CLSID &objIID, owl::TRect *pos=0)
 
TOcPartInsertObject (owl::TString &objProgId, owl::TRect *pos=0)
 
TOcControlInsertControl (TOcInitInfo &initInfo, owl::TRect *pos=0, int id=0)
 
TOcControlInsertControl (CLSID &ocxIID, owl::TRect *pos=0, int id=0)
 
TOcControlInsertControl (const owl::TString &ocxProgID, owl::TRect *pos=0, int id=0)
 
TOcControlGetOcControlOfOCX (CLSID ocxIID, owl::uint id=0)
 
- Public Member Functions inherited from owl::TWindow
void TraceWindowPlacement ()
 
 TWindow (TWindow *parent, LPCTSTR title=nullptr, TModule *module=nullptr)
 Adds this to the child list of parent if nonzero, and calls EnableAutoCreate so that this will be created and displayed along with parent.
 
 TWindow (TWindow *parent, const tstring &title, TModule *module=nullptr)
 String-aware overload.
 
 TWindow (HWND handle, TModule *module=nullptr)
 Constructs a TWindow that is used as an alias for a non-ObjectWindows window, and sets wfAlias.
 
virtual ~TWindow () override
 Destroys this window (unless this is an alias) and the children.
 
TApplicationGetApplication () const
 Gets a pointer to the TApplication object associated with this.
 
virtual bool Register ()
 Registers the Windows registration class of this window, if this window is not already registered.
 
TScrollerGetScroller ()
 Returns the associated scroller object for this window.
 
void SetScroller (TScroller *scroller)
 Sets the scroller object for this window.
 
virtual void CloseWindow (int retVal=0)
 Determines if it is okay to close a window before actually closing the window.
 
TWindowAttrGetWindowAttr ()
 Returns the TWindowAttr structure, which contains the window's creation attributes.
 
const TWindowAttrGetWindowAttr () const
 Returns the TWindowAttr structure, which contains the window's creation attributes.
 
LPCTSTR GetCaption () const
 Returns the Title member of TWindow.
 
void ChildBroadcastMessage (TMsgId, TParam1=0, TParam2=0)
 Sends the specified message to all immediate children using SendMessage.
 
TResult HandleMessage (TMsgId, TParam1=0, TParam2=0)
 Dispatches the given message using the response table.
 
virtual TResult EvNotify (uint id, TNotify &notifyInfo)
 Handles WM_NOTIFY and subdispatch messages from child controls.
 
TResult DefaultProcessing ()
 Handles default processing of events, which includes continued processing of menu/accelerators commands and enablers, as well as notifications.
 
virtual void Paint (TDC &dc, bool erase, TRect &rect)
 Repaints the client area (the area you can use for drawing) of a window.
 
void SubclassWindowFunction ()
 Installs the instance thunk as the WindowProc and saves the old window function in DefaultProc.
 
void SetFlag (uint mask)
 Sets the specified TWindow wfXxxx constant flags (for example wfAlias, wfTransfer, and so on) in the Flags member.
 
void ClearFlag (uint mask)
 Clears the specified TWindow wfXxxx constant flags (for example wfAlias, wfTransfer, and so on) in the Flags member.
 
bool IsFlagSet (uint mask)
 Returns the state of the bit flag in Attr.Flags whose mask is supplied.
 
void EnableAutoCreate ()
 Ensures that an associated child window interface element is created and displayed along with its parent window.
 
void DisableAutoCreate ()
 Disables the feature that allows an associated child window interface element to be created and displayed along with its parent window.
 
virtual TTooltipGetTooltip () const
 
virtual void EnableTooltip (bool enable=true)
 
void SetTooltip (TTooltip *tooltip)
 
void EnableTransfer ()
 Enables the transfer mechanism, which allows state data to be transferred between the window and a transfer buffer.
 
void DisableTransfer ()
 Disables (for the interface object) the transfer mechanism, which allows state data to be transferred to and from a transfer buffer.
 
TModuleGetModule () const
 Returns a pointer to the module object.
 
void SetModule (TModule *module)
 Sets the default module for this window.
 
tstring LoadString (uint id) const
 
HBITMAP LoadBitmap (TResId id) const
 
HACCEL LoadAccelerators (TResId id) const
 
HMENU LoadMenu (TResId id) const
 
HCURSOR LoadCursor (TResId id) const
 
HICON LoadIcon (TResId id) const
 
std::string LoadHtml (TResId id) const
 
virtual bool Create ()
 Creates the window interface element to be associated with this ObjectWindows interface element.
 
bool CreateChildren ()
 Creates the child windows in the child list whose auto-create flags (with wfAutoCreate mask) are set.
 
virtual void Destroy (int retVal=0)
 Destroys an MS-Windows element associated with the TWindow.
 
virtual int Execute ()
 Creates the underlying HWND and makes it modal with the help of TApplication's BeginModal support.
 
virtual int DoExecute ()
 Do actual modal execution using the Begin/End Modal support of TApplication.
 
void AttachHandle (HWND handle)
 
void DetachHandle ()
 
virtual bool PreProcessMsg (MSG &msg)
 Called from TApplication::ProcessAppMsg() to give the window an opportunity to perform preprocessing of the Windows message.
 
virtual bool IdleAction (long idleCount)
 Called when no messages are waiting to be processed, IdleAction performs idle processing as long as true is returned.
 
virtual bool HoldFocusHWnd (HWND hLose, HWND hGain)
 Responds to a request by a child window to hold its HWND when it is losing focus.
 
int GetId () const
 Returns Attr.Id, the ID used to find the window in a specified parent's child list.
 
auto ChildWithId (int id) const -> const TWindow *
 
auto ChildWithId (int id) -> TWindow *
 Returns a pointer to the window in the child window list that has the supplied id.
 
HWND GetParentH () const
 Return the handle of the parent.
 
TWindowGetParentO () const
 Return the OWL's parent for this window.
 
TWindowGetParent () const
 Retrieves the OWL object of the parent window. If none exists, returns 0.
 
virtual void SetParent (TWindow *newParent)
 Sets the parent for the specified window by setting Parent to the specified new Parent window object.
 
void SetNext (TWindow *next)
 Sets the next window in the sibling list.
 
bool SetDocTitle (const tstring &docname, int index)
 
void SetCaption (LPCTSTR title)
 Copies title to an allocated string pointed to by title.
 
void SetCaption (const tstring &title)
 
void SetCaption (uint resourceStringId)
 Sets the window title to the resource string identified by the given id.
 
bool SetCursor (TModule *module, TResId resId)
 Sets the mouse cursor for the window, loading the given resId from the given module.
 
auto GetBkgndColor () const -> TColor
 Returns the overriding background color set for the window.
 
void SetBkgndColor (TColor color, bool shouldUpdate=true)
 Sets the background color for the window.
 
auto GetTextColor () const -> TColor
 Returns the overriding text color set for the window.
 
void SetTextColor (TColor color, bool shouldUpdate=true)
 Sets the text color for the window.
 
void SetAcceleratorTable (TResId resId)
 
TResult ForwardMessage (HWND handle, bool send=true)
 Forwards the window's current message.
 
TResult ForwardMessage (bool send=true)
 Forwards the window's current message.
 
void SendNotification (int id, int notifyCode, HWND hCtl, TMsgId=WM_COMMAND)
 Repacks a command message (msg) so that a child window (hCtl) can send a message to its parent regardless of whether this is a WIN16 or WIN32 application.
 
void SendNotification (HWND receiver, int id, int notifyCode, HWND hCtl, TMsgId=WM_COMMAND)
 Repacks a command message (msg) so that a child window (hCtl) can send a message to its parent regardless of whether this is a WIN16 or WIN32 application.
 
TResult SendNotification (int id, NMHDR &, TMsgId=WM_NOTIFY)
 Repacks a command message (msg) so that a child window (hCtl) can send a message to its parent regardless of whether this is a WIN16 or WIN32 application.
 
TResult SendNotification (HWND receiver, uint id, NMHDR &, TMsgId=WM_NOTIFY)
 Repacks a command message (msg) so that a child window (hCtl) can send a message to its parent regardless of whether this is a WIN16 or WIN32 application.
 
virtual TResult WindowProc (TMsgId, TParam1, TParam2)
 First virtual function called to handling incoming messages to a TWindow.
 
virtual TResult DefWindowProc (TMsgId, TParam1, TParam2)
 Virtual function provides final default processing for an incoming message Calls original window proc that was subclassed, using ::CallWindowProc to make sure that registers get setup correctly.
 
void RouteCommandEnable (HWND hInitCmdTarget, TCommandEnabler &ce)
 Walks the chain of windows from the initial target window to this window.
 
void SetTransferBuffer (void *transferBuffer, uint size)
 Sets TransferBuffer and TransferBufferSize.
 
template<class TBuffer >
void SetTransferBuffer (TBuffer *transferBuffer)
 Sets TransferBuffer and TransferBufferSize.
 
template<class TElement , uint Count>
void SetTransferBuffer (TElement(&transferBuffer)[Count])
 Sets TransferBuffer and TransferBufferSize.
 
voidGetTransferBuffer () const
 
uint GetTransferBufferSize () const
 
virtual uint Transfer (void *buffer, TTransferDirection direction)
 Transfers data to or from any window with or without children and returns the total size of the data transferred.
 
virtual void TransferData (TTransferDirection direction)
 Transfers data between the TWindow's data buffer and the child windows in its ChildList (data is not transfered between any child windows whose wfTransfer flag is not set)
 
HWND GetHandle () const
 Returns the handle of the window.
 
 operator HWND () const
 Allows a TWindow& to be used as an HWND in Windows API calls by providing an implicit conversion from TWindow to HWND.
 
bool IsWindow () const
 Returns true if an HWND is being used.
 
auto GetClassName (TCHAR *className, int maxCount) const -> int
 Returns the Windows class name for this object's window handle.
 
long GetClassLong (int index) const
 Retrieves the 32-bit value containing information about the window class.
 
long SetClassLong (int index, long newLong)
 Sets the long value at the specified offset (index).
 
uint16 GetClassWord (int index) const
 Gets a 16-bit value containing information about the class or style of the window.
 
uint16 SetClassWord (int index, uint16 newWord)
 Sets the word value at the specified offset (index).
 
LONG_PTR GetWindowLongPtr (int index) const
 Retrieves information about the window depending on the value stored in index.
 
LONG_PTR SetWindowLongPtr (int index, LONG_PTR newLong)
 Changes information about the window. For a list of constants, see GetWindowLongPtr()
 
long GetWindowLong (int index) const
 Retrieves information about the window depending on the value stored in index.
 
long SetWindowLong (int index, long newLong)
 Changes information about the window.
 
uint16 GetWindowWord (int index) const
 Retrieves information about this window depending on the value of index.
 
uint16 SetWindowWord (int index, uint16 newWord)
 Changes information about the window.
 
WNDPROC GetWindowProc () const
 
WNDPROC SetWindowProc (WNDPROC wndProc)
 
int EnumProps (PROPENUMPROC proc)
 Enumerates all the items in the property list of the current window and passes them one by one to the callback function indicated in proc.
 
HANDLE GetProp (uint16 atom) const
 Returns a handle to the property list of the specified window.
 
HANDLE RemoveProp (uint16 atom) const
 Removes the property specified by atom from the application's property list.
 
bool SetProp (uint16 atom, HANDLE data) const
 Adds an item to the property list of the specified window.
 
HANDLE GetProp (LPCTSTR str) const
 Returns a handle to the property list of the specified window.
 
HANDLE GetProp (const tstring &str) const
 
HANDLE RemoveProp (LPCTSTR str) const
 Removes the property specified by str, a null-terminated string, from the application's property list.
 
HANDLE RemoveProp (const tstring &str) const
 
bool SetProp (LPCTSTR str, HANDLE data) const
 Adds an item to the property list of the specified window.
 
bool SetProp (const tstring &str, HANDLE data) const
 
uint32 GetStyle () const
 Gets the style bits of the underlying window or the 'Style' member of the attribute structure associated with this TWindow object.
 
uint32 SetStyle (uint32 style)
 Sets the style bits of the underlying window or the 'Style' member of the attribute structure associated with this TWindow object.
 
uint32 GetExStyle () const
 Gets the extra style bits of the window.
 
uint32 SetExStyle (uint32 style)
 Sets the extra style bits of the window.
 
bool ModifyStyle (uint32 offBits, uint32 onBits, uint swpFlags=0)
 Modifies the style bits of the window.
 
bool ModifyExStyle (uint32 offBits, uint32 onBits, uint swpFlags=0)
 Modifies the style bits of the window.
 
bool MoveWindow (int x, int y, int w, int h, bool repaint=false)
 Repositions the specified window.
 
bool MoveWindow (const TRect &rect, bool repaint=false)
 Repositions the window.
 
virtual bool ShowWindow (int cmdShow)
 Displays this TWindow in a given state.
 
void ShowOwnedPopups (bool show)
 Shows or hides all owned pop-up windows according to the value of show.
 
bool IsWindowVisible () const
 Returns true if the window is visible.
 
bool IsZoomed () const
 Returns true if window is zoomed or maximized.
 
bool IsIconic () const
 Returns true if window is iconic or minimized.
 
int GetWindowTextLength () const
 Returns the length, in characters, of the specified window's title.
 
int GetWindowText (TCHAR *str, int maxCount) const
 Copies the window's title into a buffer pointed to by string.
 
tstring GetWindowText () const
 String-aware overload.
 
void SetWindowText (LPCTSTR str)
 Sets the window's text to the given string (by copying).
 
void SetWindowText (const tstring &str)
 
void SetWindowText (uint resourceStringId)
 Sets the window title to the resource string identified by the given id.
 
WINDOWPLACEMENT GetWindowPlacement () const
 Wrapper for Windows API.
 
void SetWindowPlacement (const WINDOWPLACEMENT &place)
 Wrapper for Windows API.
 
virtual void Invalidate (bool erase=true)
 Invalidates (mark for painting) the entire client area of a window.
 
virtual void InvalidateRect (const TRect &rect, bool erase=true)
 Invalidates a specified client area.
 
void InvalidateRgn (HRGN hRgn, bool erase=true)
 Invalidates a client area within a region specified by the hRgn parameter when the application receives a WM_PAINT message.
 
void Validate ()
 Calls the function ValidateRect to validate (that is, remove from the area to be updated) the entire client area (the area you can use for drawing).
 
void ValidateRect (const TRect &rect)
 Validates a portion of the client area indicated by rect.
 
void ValidateRgn (HRGN hRgn)
 Validates the client area within a region of the current window.
 
void UpdateWindow ()
 Updates the client area of the specified window by immediately sending a WM_PAINT message.
 
bool FlashWindow (bool invert)
 Changes the window from active to inactive or vice versa.
 
bool GetUpdateRect (TRect &rect, bool erase=true) const
 Retrieves the screen coordinates of the rectangle that encloses the updated region of the specified window.
 
int GetUpdateRgn (TRegion &rgn, bool erase=true) const
 Copies a window's update region into a region specified by region.
 
bool LockWindowUpdate (bool lock=true)
 Prevents or enables window drawing for one window at a time.
 
bool RedrawWindow (TRect *update, HRGN hUpdateRgn, uint redrawFlags=RDW_INVALIDATE|RDW_UPDATENOW|RDW_ERASE)
 Redraws the rectangle specified by update and the region specified by hUpdateRgn.
 
auto GetWindowRgn (TRegion &) const -> int
 Obtains a copy of the region of the window within which the system permits drawing.
 
void ResetWindowRgn (bool repaint=false)
 Calls SetWindowRgn(nullptr, repaint).
 
auto SetWindowRgn (HRGN, bool repaint=false) -> bool
 Sets the area within the window where the system permits drawing.
 
auto SetWindowRgn (const TRegion &, bool repaint=false) -> bool=delete
 
auto SetWindowRgn (TRegion &&r, bool repaint=false) -> bool
 Overload for TRegion.
 
int GetDlgCtrlID () const
 Returns the ID of the control.
 
HWND GetDlgItem (int childId) const
 Retrieves the handle of a control specified by childId.
 
uint GetDlgItemInt (int childId, bool *translated=0, bool isSigned=true) const
 Translates the text of a specified control into an integer value and returns it.
 
void SetDlgItemInt (int childId, uint value, bool isSigned=true) const
 Sets the child window with the Id (childId) in the window to the integer value specified in value.
 
int GetDlgItemText (int childId, TCHAR *text, int maxValue) const
 Retrieves the text of a control specified by childId.
 
tstring GetDlgItemText (int childId) const
 String-aware overload.
 
void SetDlgItemText (int childId, LPCTSTR text) const
 Sets the title or text of a control in a dialog box.
 
void SetDlgItemText (int childId, const tstring &text) const
 
void SetDlgItemText (int childId, uint resourceStringId) const
 
uint IsDlgButtonChecked (int buttonId) const
 Indicates if the child button specified in the integer parameter, buttonId, is checked, or if a button is grayed, checked, or neither.
 
bool IsChild (HWND hWnd) const
 Returns true if the window is a child window or a descendant window of this window.
 
HWND GetNextDlgGroupItem (HWND hWndCtrl, bool previous=false) const
 Returns either the next or the previous control in the dialog box.
 
HWND GetNextDlgTabItem (HWND hWndCtrl, bool previous=false) const
 Returns the handle of the first control that lets the user press the Tab key to move to the next control (that is, the first control with the WS_TABSTOP style associated with it).
 
void CheckDlgButton (int buttonId, uint check)
 Places a check mark in (or removes a check mark from) the button specified in buttonId.
 
void CheckRadioButton (int firstButtonId, int lastButtonId, int checkButtonId)
 Checks the radio button specified by checkButtonId and removes the check mark from the other radio buttons in the group.
 
void SetDlgItemFont (int childId, HFONT f, bool redraw=false) const
 
HFONT GetDlgItemFont (int childId) const
 
TRect GetDlgItemRect (int childId) const
 Returns the window rectangle of the given child, specified in this window's client coordinates.
 
HMENU GetMenu () const
 Returns the handle to the menu of the indicated window.
 
HMENU GetSystemMenu (bool revert=false) const
 Returns a handle to the system menu so that an application can access the system menu.
 
bool SetMenu (HMENU hMenu)
 Sets the specified window's menu to the menu indicated by hMenu.
 
bool HiliteMenuItem (HMENU hMenu, uint idItem, uint hilite)
 Either highlights or removes highlighting from a top-level item in the menu.
 
void DrawMenuBar ()
 DrawMenuBar redraws the menu bar.
 
bool KillTimer (UINT_PTR timerId)
 Gets rid of the timer and removes any WM_TIMER messages from the message queue.
 
UINT_PTR SetTimer (UINT_PTR timerId, uint timeout, TIMERPROC proc=0)
 Creates a timer object associated with this window.
 
bool RegisterHotKey (int idHotKey, uint modifiers, uint virtKey)
 Registers a hotkey ID with the current application.
 
bool UnregisterHotKey (int idHotKey)
 Unregisters a hotkey ID with the current application.
 
bool WinHelp (LPCTSTR helpFile, uint command, ULONG_PTR data) const
 Invokes a specified help system.
 
bool WinHelp (const tstring &helpFile, uint command, ULONG_PTR data) const
 
void AssignContextMenu (TPopupMenu *menu)
 Associates a pop-up menu with the window so that it can automatically handle a WM_CONTEXTMENU message.
 
TPopupMenuGetContextMenu () const
 Returns the associated popup menu used by the window.
 
int MessageBox (LPCTSTR text, LPCTSTR caption=0, uint flags=MB_OK) const
 Creates and displays a message box that contains a message (text), a title (caption), and icons or push buttons (type).
 
int MessageBox (const tstring &text, const tstring &caption=tstring(), uint flags=MB_OK) const
 
int MessageBox (uint resId, LPCTSTR caption=0, uint flags=MB_OK) const
 
int MessageBox (uint resId, const tstring &caption, uint flags=MB_OK) const
 
auto MessageBoxIndirect (HINSTANCE resourceModule, TResId text, TResId caption, uint flags, TResId icon, DWORD_PTR contextHelpId, MSGBOXCALLBACK, DWORD languageId) const -> int
 Displays a standard message box.
 
auto MessageBoxIndirect (TResId icon, const tstring &text, const tstring &caption, uint flags=MB_OK) const -> int
 Displays a standard message box using the given icon.
 
auto FormatMessageBox (const tstring &formatStr, const tstring &caption, uint flags,...) const -> int
 
auto FormatMessageBox (const tstring &, std::nullptr_t, uint,...) const -> int=delete
 
HTASK GetWindowTask () const
 Returns a handle to the task that created the specified window.
 
void DragAcceptFiles (bool accept)
 If a window can process dropped files, DragAcceptFiles sets accept to true.
 
TCurrentEventGetCurrentEvent ()
 Returns the current event to be processed in the message queue.
 
void SethAccel (HACCEL)
 
auto GetChildren ()
 Returns a TWindow::TChildrenRange that can be iterated by standard means.
 
auto GetChildren () const
 Const overload of TWindow::GetChildren.
 
TWindowNext ()
 Returns a pointer to the next sibling window in the window's sibling list.
 
auto Next () const -> const TWindow *
 
TWindowPrevious ()
 Returns a pointer to the TWindow's previous sibling (the window previous to the TWindow in its parent's child window list)
 
auto Previous () const -> const TWindow *
 
TWindowGetFirstChild ()
 Returns a pointer to the first child window, which is the first window created in the interface object's child list.
 
auto GetFirstChild () const -> const TWindow *
 
TWindowGetLastChild ()
 Returns a pointer to the last child window in the interface object's child list.
 
auto GetLastChild () const -> const TWindow *
 
uint NumChildren () const
 Returns the number of child windows of the window.
 
bool GetScrollInfo (int bar, SCROLLINFO *scrollInfo) const
 Retrieves the properties of the given scroll bar.
 
SCROLLINFO GetScrollInfo (int bar, uint mask=SIF_ALL) const
 Function-style overload Returns selected properties of the given scroll bar.
 
int SetScrollInfo (int bar, SCROLLINFO *scrollInfo, bool redraw=true)
 Sets the properties of the given scroll bar.
 
int GetScrollPos (int bar) const
 Returns the thumb position in the scroll bar.
 
int SetScrollPos (int bar, int pos, bool redraw=true)
 Sets the thumb position in the scroll bar.
 
int GetScrollTrackPos (int bar) const
 Returns the thumb track position in the scroll bar.
 
void GetScrollRange (int bar, int &minPos, int &maxPos) const
 Returns the minimum and maximum positions in the scroll bar.
 
TScrollRange GetScrollRange (int bar) const
 Function-style overload.
 
void SetScrollRange (int bar, int minPos, int maxPos, bool redraw=true)
 Sets the thumb position in the scroll bar.
 
void SetScrollRange (int bar, const TScrollRange &, bool redraw=true)
 Overload taking the range as a pair.
 
int GetScrollPage (int bar) const
 Returns the page property (SCROLLINFO::nPage) of the given scroll bar.
 
void SetScrollPage (int bar, int page, bool redraw=true)
 Sets the page property (SCROLLINFO::nPage) of the given scroll bar.
 
bool EnableScrollBar (uint sbFlags=SB_BOTH, uint arrowFlags=ESB_ENABLE_BOTH)
 Disables or enables one or both of the scroll bar arrows on the scroll bars associated with this window.
 
void ShowScrollBar (int bar, bool show=true)
 Displays or hides the scroll bar.
 
void ScrollWindow (int dx, int dy, const TRect *scroll=nullptr, const TRect *clip=nullptr)
 Scrolls a window in the vertical (dx) and horizontal (dy) directions.
 
void ScrollWindowEx (int dx, int dy, const TRect *scroll=0, const TRect *clip=0, HRGN hUpdateRgn=nullptr, TRect *update=0, uint flags=0)
 Scrolls a window in the vertical (dx) and horizontal (dy) directions.
 
void ShutDownWindow (int retVal=0)
 This inline version of ShutDownWindow calls the static version of ShutDownWindow.
 
TResult SendMessage (TMsgId, TParam1=0, TParam2=0) const
 Sends a message (msg) to a specified window or windows.
 
TResult SendDlgItemMessage (int childId, TMsgId, TParam1=0, TParam2=0)
 Sends a message (msg) to the control specified in childId.
 
bool PostMessage (TMsgId, TParam1=0, TParam2=0)
 Posts a message (msg) to the window in the application's message queue.
 
HWND SetCapture ()
 Sets the mouse capture to the current window.
 
HWND SetFocus ()
 Sets the keyboard focus to current window and activates the window that receives the focus by sending a WM_SETFOCUS message to the window.
 
bool IsWindowEnabled () const
 Returns true if the window is enabled.
 
virtual bool EnableWindow (bool enable)
 Allows the given window to receive input from the keyboard of mouse.
 
void SetRedraw (bool redraw)
 Sends a WM_SETREDRAW message to a window so that changes can be redrawn (redraw = true) or to prevent changes from being redrawn (redraw = false).
 
bool TrackMouseEvent (uint flags=TME_HOVER|TME_LEAVE, int hoverTime=HOVER_DEFAULT)
 Posts messages when the mouse pointer leaves a window or hovers over a window for a specified amount of time.
 
bool CancelMouseEvent (uint flags=TME_HOVER|TME_LEAVE)
 Encapsulates a call to TrackMouseEvent, passing the TME_CANCEL flag.
 
TRACKMOUSEEVENT QueryMouseEventTracking () const
 Returns the current state of mouse event tracking initiated by TrackMouseEvent.
 
void ClientToScreen (TPoint &point) const
 Converts the client coordinates specified in point to screen coordinates for the new window.
 
TPoint MapClientToScreen (const TPoint &p) const
 Function-style version of ClientToScreen.
 
void MapClientToScreen (TPoint *p, int count) const
 Maps the given points, specified in client coordinates in this window, to screen coordinates.
 
template<size_t Count>
void MapClientToScreen (TPoint(&p)[Count]) const
 Overload for array See MapClientToScreen(TPoint*, int).
 
TRect MapClientToScreen (const TRect &r) const
 Functional-style overload for TRect; converts the given rectangle coordinates and returns the result.
 
void ScreenToClient (TPoint &point) const
 Uses the screen coordinates specified in point to calculate the client window's coordinates and then places the new coordinates into point.
 
TPoint MapScreenToClient (const TPoint &p) const
 Functional-style version of ScreenToClient.
 
void MapScreenToClient (TPoint *p, int count) const
 Maps the given points, specified in screen coordinates, to client coordinates in this window.
 
template<size_t Count>
void MapScreenToClient (TPoint(&p)[Count]) const
 Overload for array See MapScreenToClient(TPoint*, int).
 
TRect MapScreenToClient (const TRect &r) const
 Functional-style overload for TRect; converts the given rectangle coordinates and returns the result.
 
void MapWindowPoints (HWND hWndTo, TPoint *pts, int count) const
 Maps a set of points in one window to a relative set of points in another window.
 
void MapWindowPoints (const TWindow &wndTo, TPoint *p, int n) const
 Overload for TWindow See MapWindowPoints(HWND, TPoint*, int).
 
template<size_t Count>
void MapWindowPoints (HWND hWndTo, TPoint(&p)[Count]) const
 Overload for array See MapWindowPoints(HWND, TPoint*, int).
 
template<size_t Count>
void MapWindowPoints (const TWindow &wndTo, TPoint(&p)[Count]) const
 Overload for TWindow and array See MapWindowPoints(HWND, TPoint*, int).
 
TPoint MapWindowPoints (HWND hWndTo, const TPoint &p) const
 Functional-style overload for TPoint; converts the given point coordinates and returns the result.
 
TPoint MapWindowPoints (const TWindow &wndTo, const TPoint &p) const
 Overload for TWindow and TPoint See MapWindowPoints(HWND, const TPoint&).
 
TRect MapWindowPoints (HWND hWndTo, const TRect &r) const
 Functional-style overload for TRect; converts the given rectangle coordinates and returns the result.
 
TRect MapWindowPoints (const TWindow &wndTo, const TRect &r) const
 Overload for TWindow and TRect See MapWindowPoints(HWND, const TRect&).
 
TRect MapWindowRect (HWND hWndTo) const
 Maps the window's rectangle (GetWindowRect) to client coordinates in the given destination window.
 
TRect MapWindowRect (const TWindow &wndTo) const
 Overload for TWindow See MapWindowRect(HWND).
 
TRect MapClientRect (HWND hWndTo) const
 Maps the window's client rectangle (GetClientRect) to client coordinates in the given destination window.
 
TRect MapClientRect (const TWindow &wndTo) const
 Overload for TWindow See MapClientRect(HWND).
 
void GetClientRect (TRect &rect) const
 Gets the coordinates of the window's client area and then copies them into the object referred to by TRect.
 
TRect GetClientRect () const
 Gets the coordinates of the window's client area (the area in a window you can use for drawing).
 
HWND ChildWindowFromPoint (const TPoint &point) const
 Determines which of the child windows contains the point specified in TPoint.
 
void GetWindowRect (TRect &rect) const
 Gets the screen coordinates of the window's rectangle and copies them into rect.
 
TRect GetWindowRect () const
 Gets the screen coordinates of the window's rectangle.
 
TRect GetChildRect (HWND hWnd) const
 Returns the window rectangle of the given window, specified in this window's client coordinates.
 
TRect GetChildRect (const TWindow &wnd) const
 Overload for TWindow See GetChildRect(HWND).
 
void BringWindowToTop ()
 Brings a pop-up or child window to the top of the stack of overlapping windows and activates it.
 
HWND SetActiveWindow ()
 Activates a top-level window.
 
HWND GetLastActivePopup () const
 Returns the last active pop-up window in the list.
 
HWND GetNextWindow (uint dirFlag) const
 Finds the handle associated with either the next or previous window in the window manager's list.
 
HWND GetTopWindow () const
 Returns a handle to the top window currently owned by this parent window.
 
HWND GetWindow (uint cmd) const
 Returns the handle of the window that has the indicated relationship to this window.
 
bool SetWindowPos (HWND hWndInsertAfter, const TRect &rect, uint flags)
 Changes the size of the window pointed to by rect.
 
bool SetWindowPos (HWND hWndInsertAfter, int x, int y, int w, int h, uint flags)
 Set the new window position.
 
void CreateCaret (HBITMAP hBitmap)
 Creates a new caret for the system.
 
void CreateCaret (bool isGray, int width, int height)
 Create a new caret for the system with the specified shape, bitmap shade, width, and height.
 
void HideCaret ()
 Removes the caret from the specified display screen.
 
void ShowCaret ()
 Displays the caret in the specified shape in the active window at the current position.
 
void SetWindowFont (HFONT font, bool redraw=true)
 Sets the font that a control uses to draw text.
 
void SetWindowFont (const TFont &font, bool redraw=true)
 Sets the font that a control uses to draw text.
 
HFONT GetWindowFont ()
 Gets the font the control uses to draw text.
 
- Public Member Functions inherited from owl::TEventHandler
virtual bool Find (TEventInfo &info, TEqualOperator op=0)
 Searches the list of response table entries looking for a match.
 
TResult Dispatch (TEventInfo &info, TParam1, TParam2=0)
 Takes the message data from TEventInfo's Msg data member and dispatches it to the correct event-handling function.
 
TResult DispatchMsg (TMsgId, uint id, TParam1, TParam2)
 Search for the event given the message and it and dispatch to the event handler if found.
 
- Public Member Functions inherited from owl::TStreamableBase
virtual ~TStreamableBase ()
 
- Public Member Functions inherited from owl::TView
 TView (TDocument &doc)
 Constructs a TView object of the document associated with the view.
 
virtual ~TView ()
 Frees a TView object and calls TDocument's private member function DetachView to detach the view from the associated document.
 
TDocumentGetDocument ()
 Returns a reference to the view's document.
 
void SetDocument (TDocument &)
 
uint GetViewId ()
 Returns the unique ID for this view.
 
virtual TBarDescrGetViewBar ()
 
void SetViewMenu (TMenuDescr *menu)
 
void SetViewBar (TBarDescr *bar)
 Sets the menu descriptor for this view.
 
bool IsOK ()
 true if successfully created
 
TViewGetNextView ()
 Returns the next global view ID to be assigned.
 
bool SetDocTitle (const tstring &docname, int index)
 
virtual int PropertyCount ()
 Gets the total number of properties for the TDocument object.
 
virtual int FindProperty (LPCTSTR name)
 return property index
 
int FindProperty (const tstring &name)
 
virtual int PropertyFlags (int index)
 pfXxxxx bit array
 
virtual LPCTSTR PropertyName (int index)
 locale invariant name
 
virtual int GetProperty (int index, void *dest, int textlen=0)
 Retrieves the property identified by the given index.
 
virtual bool SetProperty (int index, const void *src)
 Sets the value of the property, given the index of the property, and src, the data type (either binary or text) to which the property must be set.
 
voidGetTag () const
 Retrieves the user-defined pointer attached to this view.
 
void SetTag (void **tag)
 Associates an arbitrary (user-defined) pointer with this view.
 

Static Public Member Functions

static LPCTSTR StaticName ()
 Returns the constant string "Ole View" that is displayed in the user interface selection box.
 
- Static Public Member Functions inherited from owl::TWindow
static void ShutDownWindow (TWindow *win, int retVal=0)
 This version of ShutDownWindow unconditionally shuts down a given window, calls Destroy on the interface element, and then deletes the interface object.
 
static HWND GetCapture ()
 Returns the handle of the window that has captured the mouse.
 
static void ReleaseCapture ()
 Releases the mouse capture from this window.
 
static HWND GetFocus ()
 Gets a handle to the window that has the focus.
 
static HWND WindowFromPoint (const TPoint &point)
 Returns the handle of the window in which the specified point (point) lies.
 
static void AdjustWindowRect (TRect &rect, uint32 style, bool menu)
 Calculates the size of the window rectangle according to the indicated client-rectangle size.
 
static void AdjustWindowRectEx (TRect &rect, uint32 style, bool menu, uint32 exStyle)
 Calculates the size of a window rectangle that has an extended style.
 
static HWND GetActiveWindow ()
 Retrieves the handle of the active window.
 
static HWND GetDesktopWindow ()
 Returns a handle to the desktop window.
 
static uint GetCaretBlinkTime ()
 Retrieves the caret blink rate in milliseconds.
 
static void GetCaretPos (TPoint &point)
 Gets the position of the caret in the coordinates of the client window.
 
static TPoint GetCaretPos ()
 
static void SetCaretBlinkTime (uint16 milliSecs)
 Sets the caret blink rate in milliseconds.
 
static void SetCaretPos (int x, int y)
 Sets the position of the caret in the coordinates of the client window.
 
static void SetCaretPos (const TPoint &pos)
 Sets the position of the caret in the coordinates of the client window.
 
static void DestroyCaret ()
 DestroyCaret first checks the ownership of the caret.
 
static void GetCursorPos (TPoint &pos)
 Retrieves the cursor's current position (in window screen coordinates) and copies the values into the structure pointed to by pos.
 
static TPoint GetCursorPos ()
 
static TPoint GetMessagePos ()
 
- Static Public Member Functions inherited from owl::TView
static uint GetNextViewId ()
 Next global ID to assign.
 
static void BumpNextViewId ()
 Increments an internal count used by the Doc/View subsystem to identify each view.
 

Protected Member Functions

auto CreateOcView (owl::TRegLink *, bool isEmbedded, IUnknown *outer) -> TOcView *override
 Override TOleWindow's version to pass info to TOleDocument & provide a second chance to find the RegLink.
 
void CleanupWindow () override
 Performs a normal CleanupWindow. Also lets the OcView object know we have closed.
 
bool OtherViewExists ()
 Checks whether another TOleView already exists.
 
auto GetViewMenu () -> owl::TMenuDescr *override
 Overrides TView's GetViewMenu to make an on-the-fly decision about which menu to use: normal, or embedded.
 
auto GetFileName () -> LPCTSTR override
 
auto EvOcViewPartInvalid (TOcPartChangeInfo &changeInfo) -> bool override
 Notifies the active view of any changes made to the embedded object's data (changeInfo).
 
View notifications
bool VnInvalidate (owl::TRect &rect)
 Invalidates the view region specified by p.
 
bool VnDocOpened (int omode)
 Ensures that TOleView's data members, such as DragPart, Pos, and Scale, are initialized properly after a revert operation, which cancels any changes made to the document since the last time the document was saved to storage.
 
bool VnDocClosed (int omode)
 Sets the OcDoc data member to 0.
 
Server specific messages
bool EvOcViewClose ()
 Asks the server to close the view associated with this document.
 
bool EvOcViewSavePart (TOcSaveLoad &ocSave)
 Asks the server to save the embedded object's data to storage.
 
bool EvOcViewLoadPart (TOcSaveLoad &ocLoad)
 Asks the server to load itself from storage.
 
bool EvOcViewOpenDoc (LPCTSTR path)
 Asks the container application to open an existing document so the document can receive embedded and linked objects.
 
bool EvOcViewInsMenus (TOcMenuDescr &sharedMenu)
 Inserts the server's menu into the composite menu.
 
bool EvOcViewAttachWindow (bool attach)
 Attaches this view to its ObjectWindows parent window so the embedded object can be either opened and edited or deactivated.
 
bool EvOcViewSetLink (TOcLinkView &view)
 Responds to an OC_VIEWSETLINK message TOcLinkView sends when the server document provides a link to a container document.
 
bool EvOcViewBreakLink (TOcLinkView &view)
 Responds to an OC_VIEWBREAKLINK message that TOcLinkView sends when the server document that provides the link shuts down.
 
bool EvOcViewGetItemName (TOcItemName &item)
 Finds the item name for whole document or for the selection.
 
- Protected Member Functions inherited from ocf::TOleWindow
void SetupWindow () override
 Establishes a connection between the TOcView object and the view's HWND so the view can send notification messages to the window.
 
void CleanupWindow () override
 Performs normal window cleanup and informs the TOcView object that the window is closed.
 
auto CanClose () -> bool override
 Intercept CanClose() to interpose OpenEdit semantics.
 
bool InClient (owl::TDC &dc, owl::TPoint &point)
 Returns true if point is inside the client area of the window. Returns false otherwise.
 
auto EvCommand (owl::uint id, HWND hWndCtl, owl::uint notifyCode) -> owl::TResult override
 Overrides the usual EvCommand message to handle the OLE verbs from CM_EDITFIRSTVERB to CM_EDITLASTVERB.
 
void EvCommandEnable (owl::TCommandEnabler &) override
 Overrides the usual EvCommandEnable message in order to enable the OLE verbs from CM_EDITFIRSTVERB to CM_EDITLASTVERB.
 
void EvPaint ()
 Sets up the dc for proper scaling and scrolling and then calls the derived class's Paint method to paint the contents of the dc.
 
void EvSize (owl::uint sizeType, const owl::TSize &size)
 Passes the event to TWindow::EvSize for normal processing and forwards the event to TOcView::EvResize to let a possible in-place server adjust its size.
 
void EvMDIActivate (HWND hWndActivated, HWND hWndDeactivated)
 Responds to a message forwarded from the MDI child window (if one exists) and lets the TOcView class know that the view window child window frame has been activated or deactivated.
 
owl::uint EvMouseActivate (HWND topParent, owl::uint hitCode, owl::uint msg)
 Forwards the WM_MOUSEACTIVATE message to the top parent of the TOleWindow object.
 
void EvSetFocus (HWND hWndLostFocus)
 Responds to a change in focus of the window.
 
void CeFileClose (owl::TCommandEnabler &ce)
 Enables the FileClose command, which lets the user exit from the window view.
 
void CmEditDelete ()
 Responds to a command with an ID of CM_EDITDELETE by deleting the selected text.
 
void CmEditCut ()
 Responds to a command with an ID of CM_EDITCUT by copying the selected text to the clipboard before cutting the text.
 
void CmEditCopy ()
 Responds to a command with an ID of CM_EDITCOPY by copying the selected text to the clipboard.
 
void CmEditPaste ()
 Responds to a command with an ID of CM_EDITPASTE by pasting an object from the clipboard into the document.
 
void CmEditPasteSpecial ()
 Responds to a command with an ID of CM_EDITPASTESPECIAL by letting the user select an object from a list of available formats for pasting from the clipboard onto the document.
 
void CmEditPasteLink ()
 Responds to a command with an ID of CM_EDITPASTELINK by creating a link between the current document and the object on the clipboard.
 
void CmEditLinks ()
 Responds to a command with an ID of CM_EDITLINKS by updating the user-selected list of linked items in the current view.
 
void CmEditConvert ()
 Responds to a command with an ID of CM_EDITCONVERT by converting an object from one type to another.
 
void CmEditInsertObject ()
 Responds to a command with an ID of CM_EDITINSERTOBJECT by creating, initializing, painting, and selecting an OLE object (TOcPart object).
 
void CmEditInsertControl ()
 Responds to a command with an ID of CM_EDITINSERTCONTROL by creating, initializing, painting, and selecting an OCX control (TOcControl object).
 
void CmEditShowObjects ()
 Responds to a command with an ID of CM_EDITSHOWOBJECTS by toggling the value of the ShowObjects data member.
 
void CeEditDelete (owl::TCommandEnabler &ce)
 Enables a command with an ID of CM_EDITDELETE, which lets the user delete the selected object from the view.
 
void CeEditCut (owl::TCommandEnabler &ce)
 Enables a command with an ID of CM_EDITCUT, which lets a user copy and delete the selected object from the view.
 
void CeEditCopy (owl::TCommandEnabler &ce)
 Enables a command with an ID of CM_EDITCOPY, which lets the user copy selected object to the clipboard.
 
void CeEditPaste (owl::TCommandEnabler &ce)
 Enables a command with an ID of CM_EDITPASTE, which lets the user paste the embedded object from the clipboard.
 
void CeEditPasteSpecial (owl::TCommandEnabler &ce)
 Enables the PasteSpecial command, which lets the user select a clipboard format to be pasted or paste linked.
 
void CeEditPasteLink (owl::TCommandEnabler &ce)
 Enables a PasteLink command with an ID of CM_EDITPASTELINK, which lets the user link to the embedded object on the clipboard.
 
void CeEditLinks (owl::TCommandEnabler &ce)
 Enables a command with an ID of CM_EDITLINKS, which lets the user manually update the list of linked items in the current view.
 
void CeEditObject (owl::TCommandEnabler &ce)
 Enables a command with an ID of CM_EDITOBJECT, which lets the user edit the embedded object.
 
void CeEditConvert (owl::TCommandEnabler &ce)
 Enables a command with an ID of CM_EDITCONVERT, which lets the user convert the selected object from one format to another.
 
void CeEditVerbs (owl::TCommandEnabler &ce)
 Enables the Edit|Verbs command, which lets the user select one of the OLE-specific verbs from the Edit menu: for example, Edit, Open, or Play.
 
void CeEditInsertObject (owl::TCommandEnabler &ce)
 Enables a command with an ID of CM_EDITINSERTOBJECT if the OcApp and OcView objects exist.
 
void CeEditInsertControl (owl::TCommandEnabler &ce)
 Enables a command with an ID of CM_EDITINSERTCONTROL if the OcApp and OcView objects exist.
 
void CeEditShowObjects (owl::TCommandEnabler &ce)
 Checks or unchecks the Edit|Show Objects menu command according to the value of the ShowObjects data member.
 
void EvMouseMove (owl::uint modKeys, const owl::TPoint &point)
 Responds to a mouse move message with the appropriate transaction.
 
void EvRButtonDown (owl::uint modKeys, const owl::TPoint &point)
 Responds to a right button down message.
 
void EvLButtonUp (owl::uint modKeys, const owl::TPoint &point)
 Responds to a left button up message by ending a mouse drag action.
 
void EvLButtonDown (owl::uint modKeys, const owl::TPoint &point)
 Responds to a left button down message by beginning a mouse drag transaction at the given point.
 
void EvLButtonDblClk (owl::uint modKeys, const owl::TPoint &point)
 Responds to a mouse button double click message.
 
bool EvSetCursor (HWND hWndCursor, owl::uint hitTest, owl::uint mouseMsg)
 Performs hit testing to tell where the cursor is located within the window and what object the cursor is moving over.
 
void EvDropFiles (owl::TDropInfo dropInfo)
 This is a response method for an incoming EV_WM_DROPFILES message.
 
void EvHScroll (owl::uint scrollCode, owl::uint thumbPos, HWND hWndCtl)
 In response to a WM_HSCROLL message, EvHScroll calls TWindow::EvHScroll and invalidates the window.
 
void EvVScroll (owl::uint scrollCode, owl::uint thumbPos, HWND hWndCtl)
 In response to a WM_VSCROLL message, EvVScroll calls TWindow::EvVScroll and invalidates the window.
 
void EvMenuSelect (owl::uint menuItemId, owl::uint flags, HMENU hMenu)
 Handles WM_MENUSELECT to provide hint text in the container's status bar, based on the menu item id.
 
owl::TResult EvOcEvent (owl::TParam1 param1, owl::TParam2 param2)
 Responds to a WM_OCEVENT message and subdispatches the message based on wParam.
 
owl::TPopupMenuCreateVerbPopup (const TOcVerb &ocVerb)
 Creates and enables a pop-up menu option (ocVerb) on the Edit menu.
 
void EvDoVerb (owl::uint whichVerb)
 Executes an OLE-related menu option from the Edit menu (for example, Edit, Copy, or Play) that is associated with the selected object.
 
void Init ()
 Initializes the TOleWindow object with the appropriate window style and initializes the necessary data members (for example, sets the accelerator ID to IDA_OLEVIEW).
 
 DECLARE_RESPONSE_TABLE (TOleWindow)
 
 DECLARE_STREAMABLE_OCF (TOleWindow, 1)
 
virtual void GetInsertPosition (owl::TRect &rect)
 Gets the position (rect) where the embedded object is inserted.
 
virtual void InvalidatePart (TOcInvalidate invalid)
 Invalidates the area where the embedded object exists.
 
virtual bool Deactivate ()
 If an embedded object is no longer the active embedded object, either because the user has ended an in-place editing session or because the user has clicked outside the embedded object, call Deactivate to unselect the object.
 
virtual bool Select (owl::uint modKeys, owl::TPoint &point)
 Selects the embedded object at the specified point (measured in logical units).
 
virtual bool PaintSelection (owl::TDC &dc, bool erase, owl::TRect &rect, void *userData=0)
 Repaints the selected portion of a document on the given device context.
 
virtual bool PaintParts (owl::TDC &dc, bool erase, owl::TRect &rect, bool metafile)
 Repaints the embedded objects on the given device context.
 
virtual bool PaintLink (owl::TDC &dc, bool erase, owl::TRect &rect, owl::TString &moniker)
 Repaints part of an object on the given device context.
 
virtual void GetLogPerUnit (owl::TSize &logPerUnit)
 Gets the logical units (typically pixels) per inch for a document so that the document's embedded objects can be painted correctly on the screen device context.
 
virtual void SetScale (owl::uint16 percent)
 Sets the ratio of the embedded object's size to the size of the site.
 
virtual void SetSelection (TOcPart *part)
 Selects the embedded object indicated in the part parameter.
 
virtual bool ShowCursor (HWND wnd, owl::uint hitTest, owl::uint mouseMsg)
 Handles the WM_NCHITTEST message, setting the cursor according to its position on the screen.
 
virtual bool StartDrag (owl::uint modKeys, owl::TPoint &point)
 
LPCTSTR EvOcViewTitle ()
 Asks the container for the caption in its frame window.
 
void EvOcViewSetTitle (LPCTSTR title)
 Sets the window's caption to title.
 
bool EvOcViewBorderSpaceReq (owl::TRect *rect)
 Requests that the server create space for a tool bar in the view of an embedded object.
 
bool EvOcViewBorderSpaceSet (owl::TRect *rect)
 Requests that the server's tool bar be placed in the container's view of an embedded object.
 
bool EvOcViewDrop (TOcDragDrop &ddInfo)
 Requests a given object be dropped at a specified place on the container's window.
 
bool EvOcViewDrag (TOcDragDrop &ddInfo)
 Handles an OC_VIEWDRAG message asking the container to provide visual feedback while the user is dragging the embedded object.
 
bool EvOcViewScroll (TOcScrollDir scrollDir)
 Asks the container to scroll the view window and updates any internal state as needed.
 
bool EvOcViewGetScale (TOcScaleFactor &scaleFactor)
 Responds to an OC_VIEWGETSCALE message and gets the scaling for the server object, causing the embedded object to be displayed using the correct scaling value (for example, 120%).
 
bool EvOcViewGetSiteRect (owl::TRect *rect)
 Gets the size of the rectangle (the site) where the embedded object is to be placed.
 
bool EvOcViewSetSiteRect (owl::TRect *rect)
 Converts the rect to logical units.
 
bool EvOcViewPartActivate (TOcPart &ocPart)
 Notifies ObjectWindows container applications that an embedded object is active.
 
bool EvOcViewPasteObject (TOcInitInfo &init)
 Pastes an OLE object into the document pointed to by the TOleWindow::OcDoc data member.
 
bool EvOcPartInvalid (TOcPart &)
 Handles a WM_OCEVENT message concerning the embedded or linked object in the document and invalidates the part.
 
bool EvOcViewSavePart (TOcSaveLoad &ocSave)
 Asks the server to write an embedded object's data (the part as represented by the ocSave parameter) into storage.
 
bool EvOcViewLoadPart (TOcSaveLoad &ocLoad)
 Requests that an embedded object load itself.
 
bool EvOcViewPaint (TOcViewPaint &vp)
 Asks the server to paint an object at a given position on a specified device context.
 
bool EvOcViewInsMenus (TOcMenuDescr &sharedMenu)
 Requests that the menus in a composite menu (a menu composed of both the server's and the container's menus).
 
bool EvOcViewShowTools (TOcToolBarInfo &tbi)
 Asks the server to provide its tool bars for display in the container's window.
 
bool EvOcViewGetPalette (LOGPALETTE **palette)
 Requests the color palette to draw the object.
 
bool EvOcViewClipData (TOcFormatData &format)
 Requests clipboard data in the specified format.
 
bool EvOcViewSetData (TOcFormatData &format)
 
bool EvOcViewClose ()
 Asks the server to close a currently open document and its associated view.
 
bool EvOcViewPartSize (TOcPartSize &size)
 The server asks itself the size of its current rectangle and lets the container know about the size of the server's view in pixels.
 
bool EvOcViewOpenDoc (LPCTSTR path)
 Asks the container to open an existing document, which will be used for linking from the embedding site.
 
bool EvOcViewAttachWindow (bool attach)
 Attaches the view to its ObjectWindows parent window so that the user can perform open editing on the embedded object, or if the embedded object has been de-activated while in-place editing was occurring.
 
bool EvOcViewSetScale (TOcScaleFactor &scaleFactor)
 Responds to an OC_VIEWSETSCALE message and handles the scaling for server application, ensuring that the embedded object is displayed using the correct scaling values (for example, 120%).
 
bool EvOcViewGetItemName (TOcItemName &item)
 Handles the EV_OC_VIEWGETITEMNAME. Returns false.
 
bool EvOcViewSetLink (TOcLinkView &view)
 Responds to an OC_VIEWSETLINK message TOcLinkView sends when the server document provides a link to a container document.
 
bool EvOcViewBreakLink (TOcLinkView &view)
 EvOcViewBreakLink responds to an OC_VIEWBREAKLINK message that TOcLinkView sends when the server document that provides the link shuts down.
 
bool EvOcViewDoVerb (owl::uint verb)
 Handles the EV_OC_VIEWDOVERB message.
 
virtual bool EvOcViewTransformCoords (owl::uint verb)
 
virtual bool EvOcAmbientGetBackColor (long *rgb)
 Handles the EV_OC_AMBIENT_GETBACKCOLOR message, which is sent by an OCX control.
 
virtual bool EvOcAmbientGetForeColor (long *rgb)
 Handles the EV_OC_AMBIENT_GETFORECOLOR message, which is sent by an OCX control.
 
virtual bool EvOcAmbientGetLocaleID (long *locale)
 Handles the EV_OC_AMBIENT_GETLOCALEID message, which is sent by an OCX control.
 
virtual bool EvOcAmbientGetTextAlign (short *align)
 Handles the EV_OC_AMBIENT_GETTEXTALIGN message, which is sent by an OCX control.
 
virtual bool EvOcAmbientGetMessageReflect (bool *msgReflect)
 Handles the EV_OC_AMBIENT_GETMESSAGEREFLECT message, which is sent by an OCX control.
 
virtual bool EvOcAmbientGetUserMode (bool *mode)
 Handles the EV_OC_AMBIENT_GETUSERMODE message, which is sent by an OCX control.
 
virtual bool EvOcAmbientGetUIDead (bool *dead)
 Handles the EV_OC_AMBIENT_GETUIDEAD message, which is sent by an OCX control.
 
virtual bool EvOcAmbientGetShowGrabHandles (bool *show)
 Handles the EV_OC_AMBIENT_GETSHOWGRABHANDLES message, which is sent by an OCX control.
 
virtual bool EvOcAmbientGetShowHatching (bool *show)
 Handles the EV_OC_AMBIENT_GETSHOWHATCHING message, which is sent by an OCX control.
 
virtual bool EvOcAmbientGetDisplayAsDefault (bool *disp)
 Handles the EV_OC_AMBIENT_GETDISPLAYASDEFAULT message, which is sent by an OCX control.
 
virtual bool EvOcAmbientGetSupportsMnemonics (bool *support)
 Handles the EV_OC_AMBIENT_GETSUPPORTSMNEMONICS message, which is sent by an OCX control.
 
virtual bool EvOcAmbientGetDisplayName (owl::TString **name)
 Handles the EV_OC_AMBIENT_GETDISPLAYNAME message, which is sent by an OCX control.
 
virtual bool EvOcAmbientGetScaleUnits (owl::TString **units)
 Handles the EV_OC_AMBIENT_GETSCALEUNITS message, which is sent by an OCX control.
 
virtual bool EvOcAmbientGetFont (IDispatch **font)
 Handles the EV_OC_AMBIENT_GETFONT message, which is sent by an OCX control.
 
virtual bool EvOcAmbientSetBackColor (long rgb)
 Handles the EV_OC_AMBIENT_SETBACKCOLOR message, which is sent by an OCX control.
 
virtual bool EvOcAmbientSetForeColor (long rgb)
 Handles the EV_OC_AMBIENT_SETFORECOLOR message, which is sent by an OCX control.
 
virtual bool EvOcAmbientSetLocaleID (long locale)
 Handles the EV_OC_AMBIENT_SETLOCALEID message, which is sent by an OCX control.
 
virtual bool EvOcAmbientSetTextAlign (short align)
 Handles the EV_OC_AMBIENT_SETTEXTALIGN message, which is sent by an OCX control.
 
virtual bool EvOcAmbientSetMessageReflect (bool msgReflect)
 Handles the EV_OC_AMBIENT_SETMESSAGEREFLECT message, which is sent by an OCX control.
 
virtual bool EvOcAmbientSetUserMode (bool mode)
 Handles the EV_OC_AMBIENT_SETUSERMODE message, which is sent by an OCX control.
 
virtual bool EvOcAmbientSetUIDead (bool dead)
 Handles the EV_OC_AMBIENT_SETUIDEAD message, which is sent by an OCX control.
 
virtual bool EvOcAmbientSetShowGrabHandles (bool show)
 Handles the EV_OC_AMBIENT_SETSHOWGRABHANDLES message, which is sent by an OCX control.
 
virtual bool EvOcAmbientSetShowHatching (bool show)
 Handles the EV_OC_AMBIENT_SETSETSHOWHATCHING message, which is sent by an OCX control.
 
virtual bool EvOcAmbientSetDisplayAsDefault (bool disp)
 Handles the EV_OC_AMBIENT_SETDISPLAYASDEFAULT message, which is sent by an OCX control.
 
virtual bool EvOcAmbientSetSupportsMnemonics (bool support)
 Handles the EV_OC_AMBIENT_SETSUPPORTSMNEMONICS message, which is sent by an OCX control.
 
virtual bool EvOcAmbientSetDisplayName (owl::TString *name)
 Handles the EV_OC_AMBIENT_SETDISPLAYNAME message, which is sent by an OCX control.
 
virtual bool EvOcAmbientSetScaleUnits (owl::TString *units)
 Handles the EV_OC_AMBIENT_SETSCALEUNITS message, which is sent by an OCX control.
 
virtual bool EvOcAmbientSetFont (IDispatch *font)
 Handles the EV_OC_AMBIENT_SETFONT message, which is sent by an OCX control.
 
virtual bool EvOcCtrlClick (TCtrlEvent *pev)
 Handles the EV_OC_CTRLCLICK message, which is sent by an OCX control.
 
virtual bool EvOcCtrlDblClick (TCtrlEvent *pev)
 Handles the EV_OC_CTRLDBLCLICK message, which is sent by an OCX control.
 
virtual bool EvOcCtrlMouseDown (TCtrlMouseEvent *pev)
 Handles the EV_OC_CTRLMOUSEDOWN message, which is sent by an OCX control.
 
virtual bool EvOcCtrlMouseMove (TCtrlMouseEvent *pev)
 Handles the EV_OC_CTRLMOUSEMOVE message, which is sent by an OCX control.
 
virtual bool EvOcCtrlMouseUp (TCtrlMouseEvent *pev)
 Handles the EV_OC_CTRLMOUSEUP message, which is sent by an OCX control.
 
virtual bool EvOcCtrlKeyDown (TCtrlKeyEvent *pev)
 Handles the EV_OC_CTRLKEYDOWN message, which is sent by an OCX control.
 
virtual bool EvOcCtrlKeyUp (TCtrlKeyEvent *pev)
 Handles the EV_OC_CTRLKEYUP message, which is sent by an OCX control.
 
virtual bool EvOcCtrlErrorEvent (TCtrlErrorEvent *pev)
 Handles the EV_OC_CTRLERROREVENT message, which is sent by an OCX control.
 
virtual bool EvOcCtrlFocus (TCtrlFocusEvent *pev)
 Handles the EV_OC_CTRLFOCUS message, which is sent by an OCX control.
 
virtual bool EvOcCtrlPropertyChange (TCtrlPropertyEvent *pev)
 Handles the EV_OC_CTRLPROPERTYCHANGE message, which is sent by an OCX control.
 
virtual bool EvOcCtrlPropertyRequestEdit (TCtrlPropertyEvent *pev)
 Handles the EV_OC_PROPERTYREQUESTEDIT message, which is sent by an OCX control.
 
virtual bool EvOcCtrlCustomEvent (TCtrlCustomEvent *pev)
 Handles the EV_OC_CTRLCUSTOMEVENT message, which is sent by an OCX control.
 
- Protected Member Functions inherited from owl::TWindow
 TWindow ()
 Protected constructor for use by immediate virtually derived classes.
 
void Init (TWindow *parent, LPCTSTR title, TModule *module)
 Normal initialization of a default constructed TWindow.
 
void Init (TWindow *parent, const tstring &title, TModule *module)
 
void Init (HWND hWnd, TModule *module)
 Wrapper initialization of a default constructed TWindow.
 
virtual THandle PerformCreate ()
 Called from Create to perform the final step in creating an Windows interface element to be associated with a TWindow.
 
void SetHandle (THandle)
 Sets the window handle in a derived class.
 
void GetHWndState (bool forceStyleSync=false)
 Copies the style, coordinate, and the resource id (but not the title) from the existing HWnd into the TWindow members.
 
void GetWindowTextTitle ()
 Updates the TWindow internal caption (Title) from the current window's caption.
 
virtual void GetWindowClass (WNDCLASS &wndClass)
 Redefined by derived classes, GetWindowClass fills the supplied MS-Windows registration class structure with registration attributes, thus, allowing instances of TWindow to be registered.
 
virtual auto GetWindowClassName () -> TWindowClassName
 
void PerformSetupAndTransfer ()
 Ensures that the window is fully set up; then transfers data into the window.
 
void DispatchScroll (uint scrollCode, uint thumbPos, HWND hWndCtrl)
 Called by EvHScroll and EvVScroll to dispatch messages from scroll bars.
 
void LoadAcceleratorTable ()
 Loads a handle to the window's accelerator table specified in the TWindowAttr structure (Attr.AccelTable).
 
virtual void RemoveChild (TWindow *child)
 Removes a child window.
 
TWindowGetWindowPtr (HWND hWnd) const
 Calls TApplication:GetWindowPtr on the application associated with this window.
 
void EvClose ()
 The default response to a WM_CLOSE message is to call CloseWindow() and then have the window deleted if the Handle was really destroyed.
 
bool EvCreate (CREATESTRUCT &)
 Response method for an incoming WM_CREATE message.
 
void EvDestroy ()
 Responds to an incoming WM_DESTROY message.
 
int EvCompareItem (uint ctrlId, const COMPAREITEMSTRUCT &compareInfo)
 Handles WM_COMPAREITEM message (for owner draw controls) by forwarding message to control itself.
 
void EvDeleteItem (uint ctrlId, const DELETEITEMSTRUCT &deleteInfo)
 Handles WM_DELETEITEM message (for owner draw controls) by forwarding message to control itself.
 
void EvDrawItem (uint ctrlId, const DRAWITEMSTRUCT &drawInfo)
 
void EvMeasureItem (uint ctrlId, MEASUREITEMSTRUCT &measureInfo)
 Handles WM_MEASUREITEM message (for owner draw controls & menus) by forwarding message to control itself.
 
void EvHScroll (uint scrollCode, uint thumbPos, HWND hWndCtl)
 Response method for an incoming WM_HSCROLL message.
 
void EvVScroll (uint scrollCode, uint thumbPos, HWND hWndCtl)
 Response method for an incoming WM_VSCROLL message.
 
void EvMove (const TPoint &clientOrigin)
 Save the normal position of the window.
 
void EvNCDestroy ()
 Responds to an incoming WM_NCDESTROY message, the last message sent to an MS-Windows interface element.
 
bool EvQueryEndSession (uint flags)
 Respond to Windows attempt to close down.
 
void EvSize (uint sizeType, const TSize &size)
 Response method for an incoming WM_SIZE message.
 
void EvLButtonDown (uint modKeys, const TPoint &point)
 Response method for an incoming WM_LBUTTONDOWN message.
 
bool EvEraseBkgnd (HDC)
 Handler for WM_ERASEBKGND.
 
void EvPaint ()
 Response method for an incoming WM_PAINT message.
 
void EvSysColorChange ()
 Respond to WM_SYSCOLORCHANGE by broadcasting it to all children.
 
void EvChildInvalid (HWND hWnd)
 Handle message posted to us by a control needing assistance in dealing with invalid inputs.
 
void EvCompacting (uint compactRatio)
 The default message handler for WM_COMPACTING.
 
void EvDevModeChange (LPCTSTR devName)
 The default message handler for WM_DEVMODECHANGE.
 
void EvEnable (bool enabled)
 The default message handler for WM_ENABLE.
 
void EvEndSession (bool endSession, uint flags)
 Provides default handling for WM_ENDSESSION.
 
void EvFontChange ()
 The default message handler for WM_FONTCHANGE.
 
void EvSysCommand (uint cmdType, const TPoint &point)
 Responds to a user-selected command from the System menu or when the user selects the maximize or minimize box.
 
void EvTimeChange ()
 The default message handler for WM_TIMECHANGE.
 
void EvTimer (uint timerId)
 The default message handler for WM_TIMER.
 
void EvSettingChange (uint flags, LPCTSTR section)
 
void EvActivate (uint active, bool minimized, HWND hWndOther)
 Default message handler for WM_ACTIVATE.
 
void EvActivateApp (bool active, DWORD threadId)
 The default message handler for WM_ACTIVATEAPP.
 
void EvCancelMode ()
 The default message handler for WM_CANCELMODE.
 
void EvGetMinMaxInfo (MINMAXINFO &minmaxinfo)
 The default message handler for WM_GETMINMAXINFO.
 
int EvGetText (int bufSize, TCHAR *buf)
 The default message handler for WM_GETTEXT.
 
int EvGetTextLength ()
 The default message handler for WM_GETTEXTLENGTH.
 
void EvKillFocus (HWND hWndGetFocus)
 Handle WM_KILLFOCUS so that we can have a parent window hold onto our Handle and possibly restore focus later.
 
uint EvMouseActivate (HWND hTopLevel, uint hitCode, TMsgId)
 The default message handler for WM_MOUSEACTIVATE.
 
void EvHotKey (int idHotKey, uint modifiers, uint vk)
 
bool EvCopyData (HWND hwnd, const COPYDATASTRUCT &)
 
void EvNextDlgCtl (TParam1 handleOrDirectionFlag, bool isHandle)
 
void EvParentNotify (const TParentNotify &)
 The default message handler for WM_PARENTNOTIFY.
 
HICON EvQueryDragIcon ()
 The default message handler for WM_QUERYDRAGICON.
 
bool EvQueryOpen ()
 The default message handler for WM_QUERYOPEN.
 
void EvQueueSync ()
 The default message handler for WM_QUEUESYNC.
 
bool EvSetCursor (HWND hWndCursor, uint codeHitTest, TMsgId mouseMsg)
 Response method for an incoming WM_SETCURSOR message.
 
void EvSetFocus (HWND hWndLostFocus)
 The default message handler for WM_SETFOCUS.
 
HFONT EvGetFont ()
 The default message handler for WM_GETFONT.
 
void EvSetFont (HFONT hFont, bool redraw)
 The default message handler for WM_SETFONT.
 
void EvSetRedraw (bool redraw)
 The default message handler for WM_SETREDRAW.
 
void EvSetText (LPCTSTR text)
 The default message handler for WM_SETTEXT.
 
void EvShowWindow (bool show, uint status)
 The default message handler for WM_SHOWWINDOW.
 
void EvWindowPosChanged (const WINDOWPOS &windowPos)
 The default message handler for WM_WINDOWPOSCHANGED.
 
bool EvWindowPosChanging (WINDOWPOS &)
 The default message handler for WM_WINDOWPOSCHANGING.
 
HBRUSH EvCtlColor (HDC hDC, HWND hWndChild, uint ctlType)
 Handler for control color messages (WM_CTLCOLOR family).
 
void EvChar (uint key, uint repeatCount, uint flags)
 The default message handler for WM_CHAR.
 
void EvDeadChar (uint deadKey, uint repeatCount, uint flags)
 The default message handler for WM_DEADCHAR.
 
void EvKeyDown (uint key, uint repeatCount, uint flags)
 The default message handler for WM_KEYDOWN.
 
void EvKeyUp (uint key, uint repeatCount, uint flags)
 The default message handler for WM_KEYUP.
 
void EvSysChar (uint key, uint repeatCount, uint flags)
 The default message handler for WM_SYSCHAR.
 
void EvSysDeadChar (uint key, uint repeatCount, uint flags)
 The default message handler for WM_SYSDEADCHAR.
 
void EvSysKeyDown (uint key, uint repeatCount, uint flags)
 The default message handler for WM_SYSKEYDOWN.
 
void EvSysKeyUp (uint key, uint repeatCount, uint flags)
 The default message handler for WM_SYSKEYUP.
 
void EvLButtonDblClk (uint modKeys, const TPoint &point)
 The default message handler for WM_LBUTTONDBLCLK.
 
void EvLButtonUp (uint modKeys, const TPoint &point)
 The default message handler for WM_LBUTTONUP.
 
void EvMButtonDblClk (uint modKeys, const TPoint &point)
 The default message handler for WM_MBUTTONDBLCLK.
 
void EvMButtonDown (uint modKeys, const TPoint &point)
 The default message handler for WM_MBUTTONDOWN.
 
void EvMButtonUp (uint modKeys, const TPoint &point)
 The default message handler for WM_MBUTTONUP.
 
void EvMouseMove (uint modKeys, const TPoint &point)
 The default message handler for WM_MOUSEMOVE.
 
void EvMouseHWheel (uint modKeys, int zDelta, const TPoint &point)
 Event handler for WM_MOUSEHWHEEL.
 
void EvMouseWheel (uint modKeys, int zDelta, const TPoint &point)
 Event handler for WM_MOUSEWHEEL.
 
void EvRButtonDblClk (uint modKeys, const TPoint &point)
 The default message handler for WM_RBUTTONDBLCLK.
 
void EvRButtonDown (uint modKeys, const TPoint &point)
 The default message handler for WM_RBUTTONDOWN.
 
void EvRButtonUp (uint modKeys, const TPoint &point)
 The default message handler for WM_RBUTTONUP.
 
void EvInitMenu (HMENU hMenu)
 The default message handler for WM_INITMENU.
 
void EvInitMenuPopup (HMENU hPopupMenu, uint index, bool isSysMenu)
 Handle WM_INITMENUPOPUP while embeded to generate command enable messages for our server menu items.
 
int32 EvMenuChar (uint nChar, uint menuType, HMENU hMenu)
 The default message handler for WM_MENUCHAR.
 
void EvMenuSelect (uint menuItemId, uint flags, HMENU hMenu)
 The default message handler for WM_MENUSELECT.
 
void EvContextMenu (HWND childHwnd, int x, int y)
 The default message handler for WM_CONTEXTMENU.
 
uint EvGetDlgCode (const MSG *msg)
 The default message handler for WM_GETDLGCODE.
 
void EvEnterIdle (uint source, HWND hWndDlg)
 The default message handler for WM_ENTERIDLE.
 
void EvSpoolerStatus (uint jobStatus, uint jobsLeft)
 The default message handler for WM_SPOOLERSTATUS.
 
void EvAskCBFormatName (uint bufLen, TCHAR *buffer)
 The default message handler for WM_ASKCBFORMATNAME.
 
void EvChangeCBChain (HWND hWndRemoved, HWND hWndNext)
 The default message handler for WM_CHANGECBCHAIN.
 
void EvDrawClipboard ()
 The default message handler for WM_DRAWCLIPBOARD.
 
void EvDestroyClipboard ()
 The default message handler for WM_DESTROYCLIPBOARD.
 
void EvHScrollClipboard (HWND hCBViewer, uint scrollCode, uint pos)
 The default message handler for WM_HSCROLLCLIPBOARD.
 
void EvPaintClipboard (HWND hWnd, const PAINTSTRUCT &)
 The default message handler for WM_PAINTCLIPBOARD.
 
void EvRenderAllFormats ()
 The default message handler for WM_RENDERALLFORMATS.
 
void EvRenderFormat (uint dataFormat)
 The default message handler for WM_RENDERFORMAT.
 
void EvSizeClipboard (HWND hWndViewer, const TRect &)
 The default message handler for WM_SIZECLIPBOARD.
 
void EvVScrollClipboard (HWND hCBViewer, uint scrollCode, uint pos)
 The default message handler for WM_VSCROLLCLIPBOARD.
 
void EvPaletteChanged (HWND hWndPalChg)
 The default message handler for WM_PALETTECHANGED.
 
void EvPaletteIsChanging (HWND hWndPalChg)
 The default message handler for WM_PALETTEISCHANGING.
 
bool EvQueryNewPalette ()
 The default message handler for WM_QUERYNEWPALETTE.
 
void EvDropFiles (TDropInfo dropInfo)
 The default message handler for WM_DROPFILES.
 
int EvCharToItem (uint ch, HWND hWndListBox, int caretIndex)
 The default message handler for WM_CHARTOITEM.
 
int EvVKeyToItem (uint key, HWND hWndListBox, int caretIndex)
 The default message handler for WM_VKEYTOITEM.
 
bool EvNCActivate (bool active)
 The default message handler for WM_NCACTIVATE.
 
uint EvNCCalcSize (bool calcValidRects, NCCALCSIZE_PARAMS &)
 The default message handler for WM_NCCALCSIZE.
 
bool EvNCCreate (CREATESTRUCT &)
 The default message handler for WM_NCCREATE.
 
uint EvNCHitTest (const TPoint &)
 The default message handler for WM_NCHITTEST.
 
void EvNCLButtonDblClk (uint codeHitTest, const TPoint &)
 The default message handler for WM_NCLBUTTONDBLCLK.
 
void EvNCLButtonDown (uint codeHitTest, const TPoint &)
 The default message handler for WM_NCLBUTTONDOWN.
 
void EvNCLButtonUp (uint codeHitTest, const TPoint &)
 The default message handler for WM_NCLBUTTONUP.
 
void EvNCMButtonDblClk (uint codeHitTest, const TPoint &)
 The default message handler for WM_NCMBUTTONDBLCLK.
 
void EvNCMButtonDown (uint codeHitTest, const TPoint &)
 The default message handler for WM_NCMBUTTONDOWN.
 
void EvNCMButtonUp (uint codeHitTest, const TPoint &)
 The default message handler for WM_NCMBUTTONUP.
 
void EvNCMouseMove (uint codeHitTest, const TPoint &)
 The default message handler for WM_NCMOUSEMOVE.
 
void EvNCPaint (HRGN)
 The default message handler for WM_NCPAINT.
 
void EvNCRButtonDblClk (uint codeHitTest, const TPoint &)
 The default message handler for WM_NCRBUTTONDBLCLK.
 
void EvNCRButtonDown (uint codeHitTest, const TPoint &)
 The default message handler for WM_NCRBUTTONDOWN.
 
void EvNCRButtonUp (uint codeHitTest, const TPoint &)
 The default message handler for WM_NCRBUTTONUP.
 
HICON EvGetIcon (bool isBigIcon)
 
HICON EvSetIcon (bool isBigIcon, HICON)
 
- Protected Member Functions inherited from owl::TEventHandler
bool SearchEntries (const TGenericTableEntry *entries, TEventInfo &info, TEqualOperator op)
 Low-level response table search function.
 
- Protected Member Functions inherited from owl::TView
void NotOK ()
 To flag errors in creation.
 

Additional Inherited Members

- Public Types inherited from owl::TWindow
typedef HWND THandle
 TWindow encapsulates an HWND.
 
using TChildrenIterator = TChildrenIteratorTemplate<TWindow>
 
using TConstChildrenIterator = TChildrenIteratorTemplate<const TWindow>
 
using TChildrenRange = TChildrenRangeTemplate<TWindow>
 
using TConstChildrenRange = TChildrenRangeTemplate<const TWindow>
 
typedef std::pair< int, intTScrollRange
 
- Public Types inherited from owl::TEventHandler
typedef bool(* TEqualOperator) (const TGenericTableEntry &, const TEventInfo &)
 
- Public Types inherited from owl::TView
enum  TViewProp { PrevProperty = 0 , ViewClass , ViewName , NextProperty }
 These property values, which describe the basic properties of a view, are available in classes derived from TView. More...
 
- Static Protected Member Functions inherited from owl::TWindow
static LRESULT CALLBACK InitWndProc (HWND, UINT msg, WPARAM, LPARAM)
 Callback process for hooking TWindow to native window.
 
- Protected Attributes inherited from ocf::TOleWindow
TOcPartDragPart
 Points to the embedded object (the part) being dragged.
 
owl::TUIHandle::TWhere DragHit
 Indicates the position in the embedded object where the user points and clicks the mouse.
 
owl::TDCDragDC
 Points to the device context used while an object is being dragged.
 
owl::TPoint DragPt
 Indicates the point (in logical units) where the mouse is over the dragged object.
 
owl::TRect DragRect
 Holds the rectangle being dragged.
 
owl::TPoint DragStart
 Holds the point where the dragging of the embedded object began.
 
TOcScaleFactor Scale
 Holds the current scaling factor. The server uses this information to determine how to scale the document.
 
owl::TRect Pos
 Holds the current area in the window where the object is embedded.
 
TOcDocumentOcDoc
 Holds the ObjectComponents document associated with this TOleWindow.
 
TOcViewOcView
 Holds the ObjectComponents view or remote view (the server's) associated with the TOleWindow view.
 
TOcAppOcApp
 Holds the ObjectComponents application associated with this TOleWindow.
 
owl::tstring ContainerName
 Holds the name of the container.
 
bool Remote
 Returns true if the window represents an embedded server. Returns false otherwise.
 
bool ShowObjects
 Is true if the embedded object's frame (the gray or shaded brushes around the object) is displayed.
 
int MinWidth
 The minimum width of the part.
 
int MinHeight
 The minimum height of the part.
 

Detailed Description

The OLE2 window view class. Used as a view in doc/view model.

Derived from TWindowView and TView, TOleView supports the View half of the Doc/View pair and creates a window with a view that can display an associated document. Documents use views to display themselves to a user. Regardless of whether a view belongs to a server or a container, TOleView sets up a corresponding TOcDocument object (an entire compound document).

In the case of an OLE-enabled container application, view refers to the window where the container application draws the compound document, which may consist of one or more linked and embedded objects. To display these objects in different formats, a container can be associated with more than one view. Similarly, to display the data properly, each embedded object can also have its own view. Each container view creates a corresponding ObjectComponents TOcView object. If the view belongs to an OLE-enabled server application, TOleView creates a remote view on the server's document (a TOcRemView object). TOleView takes care of transmitting messages from the server to the container, specifically in the case of merging menus and redrawing embedded objects, and supports merging the server's and the container's pop-up menu items to form a composite menu. Because it knows the dimensions of the server's view, TOleView is responsible for telling the container how to redraw the embedded object.

Similarly to TView, TOleView supports the creation of views and provides several event handling functions that allow the view to query, commit, and close views. TOleView also manages the writing to storage of documents that belong to a container or a server.

Definition at line 123 of file oleview.h.

Constructor & Destructor Documentation

◆ TOleView()

ocf::TOleView::TOleView ( owl::TDocument & doc,
owl::TWindow * parent = 0 )

Constructs a TOleView object associated with the given document object (doc) and parent window (parent).

Definition at line 58 of file oleview.cpp.

References CHECK, and TYPESAFE_DOWNCAST.

◆ ~TOleView()

ocf::TOleView::~TOleView ( )

Destroys the TOleView object and detaches the view from the associated document.

Definition at line 72 of file oleview.cpp.

References owl::TWindow::Destroy(), ocf::TOleWindow::IsRemote(), and ocf::TOleWindow::OcDoc.

Member Function Documentation

◆ CanClose()

bool ocf::TOleView::CanClose ( ) -> bool
overridevirtual

A view uses this function to verify whether or not it can shut down.

If this is a server's view window, CanClose checks to see if any open-editing is occurring on any of the embedded objects in the frame window. If so, CanClose closes this open-editing session by disconnecting the embedded object from its server. Then, it hides the server's frame window and returns true when appropriate. If this is a container, CanClose queries all documents and views and returns true when all documents and views can be closed.

Note
Unlike in-place editing, which takes place in the container's window, open-editing occurs in the server's frame window.

Reimplemented from owl::TWindow.

Definition at line 143 of file oleview.cpp.

References ocf::amExeMode, CHECK, ocf::TOcDocument::Close(), owl::TWindow::GetApplication(), ocf::TOleWindow::GetOcRemView(), ocf::TOleWindow::IsOpenEditing(), ocf::TOcApp::IsOptionSet(), ocf::TOleWindow::OcApp, ocf::TOleWindow::OcDoc, ocf::TOleWindow::OleShutDown(), OtherViewExists(), and TYPESAFE_DOWNCAST.

◆ CleanupWindow()

void ocf::TOleView::CleanupWindow ( )
overrideprotectedvirtual

Performs a normal CleanupWindow. Also lets the OcView object know we have closed.

Reimplemented from owl::TWindow.

Definition at line 190 of file oleview.cpp.

References ocf::TOleWindow::CleanupWindow(), owl::TApplication::Condemn(), owl::TWindow::GetApplication(), OtherViewExists(), ocf::Parent, and TYPESAFE_DOWNCAST.

◆ CreateOcView()

TOcView * ocf::TOleView::CreateOcView ( owl::TRegLink * link,
bool isRemote,
IUnknown * outer ) -> TOcView*
overrideprotectedvirtual

Override TOleWindow's version to pass info to TOleDocument & provide a second chance to find the RegLink.

Creates an ObjectComponents view associated with the embedded object. Associates the view with the document template specified in tpl. The isEmbedded parameter is true if the view is an embedded object. The outer parameter refers to the IUnknown interface with which the view will aggregate itself.

Reimplemented from ocf::TOleWindow.

Definition at line 90 of file oleview.cpp.

References ocf::TOleWindow::CreateOcView(), owl::TView::GetDocument(), owl::TDocument::GetTemplate(), and owl::TDocument::SetEmbedded().

◆ EvOcViewAttachWindow()

bool ocf::TOleView::EvOcViewAttachWindow ( bool attach)
protected

Attaches this view to its ObjectWindows parent window so the embedded object can be either opened and edited or deactivated.

To attach a view to an embedded object, set the attach parameter to true. To detach the embedded object, set the attach parameter to false.

Definition at line 446 of file oleview.cpp.

References owl::dnCreate, owl::TWindow::GetApplication(), owl::TDocument::GetDocManager(), owl::TView::GetDocument(), ocf::TOleWindow::IsOpenEditing(), ocf::Parent, owl::TDocManager::PostEvent(), owl::TWindow::SetParent(), and TYPESAFE_DOWNCAST.

◆ EvOcViewBreakLink()

bool ocf::TOleView::EvOcViewBreakLink ( TOcLinkView & view)
protected

Responds to an OC_VIEWBREAKLINK message that TOcLinkView sends when the server document that provides the link shuts down.

EvOcViewBreakLink breaks the link with a server document or a selection by deleting the TOleLinkView associated with the TOcLinkView (view). After the link is broken, the container application is left holding a static representation (that is, a metafile) of the linked document. Returns false if unsuccessful. Non-Doc/View applications use TOleWindow's implementation of this function.

Definition at line 520 of file oleview.cpp.

References owl::TView::GetDocument(), owl::TDocument::QueryViews(), and ocf::vnLinkView.

◆ EvOcViewClose()

bool ocf::TOleView::EvOcViewClose ( )
protected

Asks the server to close the view associated with this document.

Tests to see if the document has been changed since it was last saved. Returns true if the document and its associated view are closed.

Definition at line 267 of file oleview.cpp.

References ocf::TOleWindow::EvOcViewClose(), owl::TView::GetDocument(), ocf::TOleWindow::GetOcRemView(), ocf::TOcRemView::LoadFromFile, ocf::TOleWindow::OcDoc, and ocf::TOleWindow::OcView.

◆ EvOcViewGetItemName()

bool ocf::TOleView::EvOcViewGetItemName ( TOcItemName & item)
protected

Finds the item name for whole document or for the selection.

Definition at line 477 of file oleview.cpp.

References _T, ocf::TOleWindow::DragPart, ocf::TOcPart::GetName(), ocf::TOcItemName::Name, and ocf::TOcItemName::Selection.

◆ EvOcViewInsMenus()

bool ocf::TOleView::EvOcViewInsMenus ( TOcMenuDescr & sharedMenu)
protected

Inserts the server's menu into the composite menu.

Determines the number of groups and the number of pop-up menu items to insert within each group. The shared menu (sharedMenu) is the container's menu merged with the server's menu groups.

Definition at line 385 of file oleview.cpp.

References GetViewMenu().

◆ EvOcViewLoadPart()

bool ocf::TOleView::EvOcViewLoadPart ( TOcSaveLoad & ocLoad)
protected

Asks the server to load itself from storage.

Loads the document and its associated view.

Definition at line 333 of file oleview.cpp.

References CHECK, owl::TView::GetDocument(), ocf::TOleWindow::GetOcRemView(), ocf::TOcRemView::Load(), owl::TDocument::Open(), PRECONDITION, and TYPESAFE_DOWNCAST.

◆ EvOcViewOpenDoc()

bool ocf::TOleView::EvOcViewOpenDoc ( LPCTSTR path)
protected

Asks the container application to open an existing document so the document can receive embedded and linked objects.

(Actually, TOleView calls on the TOleDocument object to read the document from storage, using the standard OLE IStorage and IStream interfaces). Assigns a unique string identifier to the document and returns true if successful.

Definition at line 361 of file oleview.cpp.

References CHECK, owl::TView::GetDocument(), ocf::TOleWindow::GetOcDoc(), owl::TWindow::Invalidate(), owl::ofRead, ocf::TOcDocument::SetName(), and TYPESAFE_DOWNCAST.

◆ EvOcViewPartInvalid()

bool ocf::TOleView::EvOcViewPartInvalid ( TOcPartChangeInfo & changeInfo) -> bool
overrideprotectedvirtual

Notifies the active view of any changes made to the embedded object's data (changeInfo).

Also, notifies any other views associated with this document that the bounding rectangle for the document is invalid and needs to be repainted. EvOcViewPartInvalid always returns true.

Reimplemented from ocf::TOleWindow.

Definition at line 417 of file oleview.cpp.

References owl::TView::GetDocument(), ocf::TOleWindow::InvalidatePart(), owl::TDC::LPtoDP(), owl::TDocument::NotifyViews(), owl::TDocument::SetDirty(), and ocf::vnInvalidate.

◆ EvOcViewSavePart()

bool ocf::TOleView::EvOcViewSavePart ( TOcSaveLoad & ocSave)
protected

Asks the server to save the embedded object's data to storage.

To save the object, EvOcViewSavePart calls upon the TOleDocument object, which creates storage as necessary for each embedded object. Saves the dimensions of the server's view, which the server uses to tell the container how to redraw the embedded object in the container's window.

Definition at line 296 of file oleview.cpp.

References owl::TView::GetDocument(), ocf::TOleWindow::GetOcRemView(), PRECONDITION, and TYPESAFE_DOWNCAST.

◆ EvOcViewSetLink()

bool ocf::TOleView::EvOcViewSetLink ( TOcLinkView & view)
protected

Responds to an OC_VIEWSETLINK message TOcLinkView sends when the server document provides a link to a container document.

EvOcViewSetLink establishes the link between a TOleLinkView and a TOcLinkView. The view parameter references the view with which the document or selection is associated. Returns false if unsuccessful. Non-Doc/View applications use TOleWIndow's implementation of the function.

Definition at line 505 of file oleview.cpp.

◆ GetFileName()

LPCTSTR ocf::TOleView::GetFileName ( ) -> LPCTSTR
inlineoverrideprotectedvirtual

Reimplemented from ocf::TOleWindow.

Definition at line 270 of file oleview.h.

References owl::TView::GetDocument(), and owl::TDocument::GetTitle().

◆ GetViewMenu()

TMenuDescr * ocf::TOleView::GetViewMenu ( ) -> owl::TMenuDescr*
overrideprotectedvirtual

Overrides TView's GetViewMenu to make an on-the-fly decision about which menu to use: normal, or embedded.

Reimplemented from owl::TView.

Definition at line 107 of file oleview.cpp.

References owl::TWindow::GetModule(), owl::TView::GetViewMenu(), ocf::TOleWindow::IsRemote(), and owl::TView::SetViewMenu().

◆ GetViewName()

LPCTSTR ocf::TOleView::GetViewName ( ) -> LPCTSTR
inlineoverridevirtual

Overrides TView's virtual GetViewName function and returns the name of the class (TOleView).

Implements owl::TView.

Definition at line 247 of file oleview.h.

References StaticName().

◆ GetWindow()

owl::TWindow * ocf::TOleView::GetWindow ( ) -> owl::TWindow*
inlineoverridevirtual

Overrides TView's virtual GetWindow function and returns the TWindow instance associated with this view.

Reimplemented from owl::TView.

Definition at line 254 of file oleview.h.

◆ OleShutDown()

bool ocf::TOleView::OleShutDown ( ) -> bool
overridevirtual

◆ OtherViewExists()

bool ocf::TOleView::OtherViewExists ( )
protected

Checks whether another TOleView already exists.

Definition at line 172 of file oleview.cpp.

References owl::TView::GetDocument(), owl::TDocument::GetViewList(), and TYPESAFE_DOWNCAST.

◆ SetDocTitle()

bool ocf::TOleView::SetDocTitle ( LPCTSTR docname,
int index ) -> bool
inlineoverridevirtual

Overrides TView's and TWindow's virtual SetDocTitle function and stores the title of the document associated with this view.

Reimplemented from owl::TWindow.

Definition at line 261 of file oleview.h.

References owl::TWindow::SetDocTitle().

◆ StaticName()

LPCTSTR ocf::TOleView::StaticName ( )
inlinestatic

Returns the constant string "Ole View" that is displayed in the user interface selection box.

Definition at line 240 of file oleview.h.

References _T.

◆ VnDocClosed()

bool ocf::TOleView::VnDocClosed ( int omode)
protected

Sets the OcDoc data member to 0.

Definition at line 255 of file oleview.cpp.

References ocf::TOleWindow::OcDoc.

◆ VnDocOpened()

bool ocf::TOleView::VnDocOpened ( int omode)
protected

Ensures that TOleView's data members, such as DragPart, Pos, and Scale, are initialized properly after a revert operation, which cancels any changes made to the document since the last time the document was saved to storage.

Definition at line 243 of file oleview.cpp.

References ocf::TOleWindow::DragPart, ocf::TOleWindow::Pos, ocf::TOcScaleFactor::Reset(), ocf::TOleWindow::Scale, and owl::TRect::SetNull().

◆ VnInvalidate()

bool ocf::TOleView::VnInvalidate ( owl::TRect & rect)
protected

Invalidates the view region specified by p.

Use this function to invalidate the bounding rectangle surrounding an embedded object if the object has been changed, usually as a result of in-place editing. If successful, returns true.

Definition at line 230 of file oleview.cpp.

References owl::TWindow::InvalidateRect().


The documentation for this class was generated from the following files: