owl::TFrameWindow Class Reference

Derived from TWindow, TFrameWindow controls such window-specific behavior as keyboard navigation and command processing for client windows. More...

#include <owl/framewin.h>

Inheritance diagram for owl::TFrameWindow:

Public Member Functions
	TFrameWindow (TWindow *parent, LPCTSTR title=nullptr, TWindow *clientWnd=nullptr, bool shrinkToClient=false, TModule *module=nullptr)
	Constructs a window object with the parent window supplied in parent, which is zero if this is the main window.
	TFrameWindow (TWindow *parent, const tstring &title, TWindow *client=nullptr, bool shrinkToClient=false, TModule *=nullptr)
	String-aware overload.
	TFrameWindow (TWindow *parent, const tstring &title, std::unique_ptr< TWindow > client=nullptr, bool shrinkToClient=false, TModule *=nullptr)
	Smart-pointer-aware overload.
	TFrameWindow (HWND hWnd, TModule *module=nullptr)
	Constructor for a TFrameWindow that is being used as an alias for a non-ObjectWindows window.
	~TFrameWindow () override
	Destructor for a TFrameWindow.
virtual bool	AssignMenu (TResId menuResId)
	Perform a high-level menu assignment either before or after the HWND for the window has been created.
virtual bool	SetMenu (HMENU newMenu)
	Overrides TWindow's non-virtual SetMenu function, thus allowing derived classes the opportunity to implement this function differently from TWindow.
void	SetMenuDescr (const TMenuDescr &menuDescr)
	Sets the menu descriptor to the new menu descriptor.
const TMenuDescr *	GetMenuDescr () const
	Returns a pointer to the menu descriptor for the frame window.
virtual bool	MergeMenu (const TMenuDescr &childMenuDescr)
	Merges the given menu descriptor with this frame's own menu descriptor and displays the resulting menu in this frame.
bool	RestoreMenu ()
void	SetBarDescr (TBarDescr *barDescr, TAutoDelete=AutoDelete)
	Sets the control bar descriptor to the new bar descriptor.
const TBarDescr *	GetBarDescr () const
	Returns a pointer to the control bar descriptor.
virtual bool	MergeBar (const TBarDescr &childBarDescr)
	Do nothing. Return false. Overriden in TDecoratedFrame.
virtual bool	RestoreBar ()
	Do nothing in TFrameWindow. Overriden in TDecoratedFrame.
TModule *	GetMergeModule ()
	Returns the module of the merge menu.
HICON	GetIcon () const
	Retrieve handle of icon of frame window.
HICON	GetIconSm () const
	Retrieve handle of icon of frame window.
bool	SetIcon (TModule *iconModule, TResId iconResId)
	Sets the icon in the module specified in iconModule to the resource ID specified in iconResId.
bool	SetIconSm (TModule *iconModule, TResId iconResIdSm)
	Set the Small Icon (16 x 16)
virtual TWindow *	GetClientWindow ()
	Returns a pointer to the client window.
virtual TWindow *	SetClientWindow (TWindow *clientWnd)
	Sets the client window to the specified window.
auto	SetClientWindow (std::unique_ptr< TWindow >) -> std::unique_ptr< TWindow >
	Smart-pointer-aware overload.
void	RemoveChild (TWindow *) override
	If someone removes our client with a RemoveChild() call, update our client and restore focus ptrs.
virtual HWND	GetCommandTarget ()
	Locates and returns the child window that is the target of the command and command enable messages.
bool	GetKeyboardHandling () const
	Returns flag indicating that the receiver has requested "keyboard handling" (translation of keyboard input into control selections).
void	SetKeyboardHandling (bool kh=true)
	Sets flag indicating that the receiver has requested "keyboard handling" (translation of keyboard input into control selections).
void	EnableKBHandler ()
	Sets the keyboard handling flag to true.
auto	PreProcessMsg (MSG &) -> bool override
	Overrides TWindow's virtual function.
auto	IdleAction (long idleCount) -> bool override
	Overrides TWindow's virtual function.
auto	HoldFocusHWnd (HWND hWndLose, HWND hWndGain) -> bool override
	Overrides TWindow's virtual function.
auto	SetDocTitle (LPCTSTR docname, int index) -> bool override
	Overrides TWindow's virtual function.
virtual bool	SetDocTitle (LPCTSTR docname, int index)
	Default behavior for updating document title is to pass it to parent frame.
bool	SetDocTitle (const tstring &docname, int index)
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.
TApplication *	GetApplication () 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.
TScroller *	GetScroller ()
	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.
TWindowAttr &	GetWindowAttr ()
	Returns the TWindowAttr structure, which contains the window's creation attributes.
const TWindowAttr &	GetWindowAttr () const
	Returns the TWindowAttr structure, which contains the window's creation attributes.
LPCTSTR	GetCaption () const
	Returns the Title member of TWindow.
virtual bool	CanClose ()
	Use this function to determine if it is okay to close a window.
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 TTooltip *	GetTooltip () 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.
TModule *	GetModule () 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 ()
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.
TWindow *	GetParentO () const
	Return the OWL's parent for this window.
TWindow *	GetParent () 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.
void *	GetTransferBuffer () 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.
TPopupMenu *	GetContextMenu () 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.
TCurrentEvent &	GetCurrentEvent ()
	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.
TWindow *	Next ()
	Returns a pointer to the next sibling window in the window's sibling list.
auto	Next () const -> const TWindow *
TWindow *	Previous ()
	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 *
TWindow *	GetFirstChild ()
	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 *
TWindow *	GetLastChild ()
	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 ()

Protected Member Functions
	TFrameWindow ()
	< String-aware overload
void	Init (TWindow *clientWnd, bool shrinkToClient)
	Normal initialization of a default constructed TFrameWindow.
auto	EvCommand (uint id, HWND hWndCtl, uint notifyCode) -> TResult override
	Handle WM_COMMAND to provide extra processing for commands: Extra processing for commands: starts with the command target window (usually the focus window) and gives it and its parent windows an opportunity to handle the command.
void	EvCommandEnable (TCommandEnabler &) override
	Handle WM_COMMAND_ENABLE to provide command enable distribution and default support for windows without command enable handlers.
void	BroadcastResizeToChildren (uint sizeType, const TSize &size)
	Tell child windows frame has minimized/maximized/restored (They may want to change enabled state or release/restore resources)
void	EvInitMenuPopup (HMENU hPopupMenu, uint index, bool isSysMenu)
	Responds to WM_INITMENUPOPUP by performing a command enable run on each of the menu items in the popup menu.
HICON	EvQueryDragIcon ()
	Responds to a WM_QUERYDRAGICON message sent to a minimized (iconic) window that is going to be dragged.
void	EvSetFocus (HWND hWndLostFocus)
	Restores the focus to the active window.
void	EvSize (uint sizeType, const TSize &size)
	Response method for an incoming WM_SIZE message.
void	EvParentNotify (const TParentNotify &)
	Responds to a message to notify the parent window that a given event has occurred.
void	EvPaletteChanged (HWND hWndPalChg)
	Forwards the WM_PALETTECHANGED message to the client window.
bool	EvQueryNewPalette ()
	Forwards the WM_QUERYNEWPALETTE message to the client window.
void	SetupWindow () override
	Calls TWindow::SetUpWindow to create windows in a child list.
void	CleanupWindow () override
	Cleans up any associated icons.
HWND	GetHWndRestoreFocus ()
	Returns the handle of the window to restore the focus to.
void	SetHWndRestoreFocus (HWND hwndRestoreFocus)
	Sets the remembered focused window.
int	GetDocTitleIndex () const
	Returns the document title index.
void	SetDocTitleIndex (int index)
	Sets the current document's title index.
void	SetMergeModule (TModule *module)
	Remembers where the merged menu came from.
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).
TWindow *	GetWindowPtr (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.

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, int >	TScrollRange
Public Types inherited from owl::TEventHandler
typedef bool(*	TEqualOperator) (const TGenericTableEntry &, const TEventInfo &)
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 Protected Member Functions inherited from owl::TWindow
static LRESULT CALLBACK	InitWndProc (HWND, UINT msg, WPARAM, LPARAM)
	Callback process for hooking TWindow to native window.

Detailed Description

Derived from TWindow, TFrameWindow controls such window-specific behavior as keyboard navigation and command processing for client windows.

For example, when a window is reactivated, TFrameWindow is responsible for restoring a window's input focus and for adding menu bar and icon support. TFrameWindow is a streamable class.

In terms of window areas, the frame area consists of the border, system menus, toolbars and status bars whereas the client area excludes these areas. Although frame windows can support a client window, the frame window remains separate from the client window so that you can change the client window without affecting the frame window.

ObjectWindows uses this frame and client structure for both TFrameWindow and TMDIChild classes. Both these classes can hold a client class. Having a separate class for the client area of the window adds more flexibility to your program. For example, this separate client area, which might be a dialog box, can be moved into another frame window, either a main window or an MDI child window.

TFrameWindow adds the notion of a client window, keyboard navigation, and special processing for commands (see member function EvCommand() )

See TFloatingFrame for a description of a floating frame with the same default functionality as a frame window.

Definition at line 96 of file framewin.h.

Constructor & Destructor Documentation

TFrameWindow() [1/5]

owl::TFrameWindow::TFrameWindow	(	TWindow *	parent,
		LPCTSTR	title = nullptr,
		TWindow *	clientWnd = nullptr,
		bool	shrinkToClient = false,
		TModule *	module = nullptr )

Constructs a window object with the parent window supplied in parent, which is zero if this is the main window.

title, which by default is zero, contains the title displayed in the window's caption bar. clientWnd is the client window for this frame window or zero if none exists. shrinkToClient controls whether the client window will size to fit the frame or the frame window will fit the client. Note that this parameter only affects the size of the main window. When a client window is used in a frame window that doesn't have shrinktoClient set, the client window resizes to fit the frame window. When a client window is used in a frame window that has the shrinktoClient set, the frame window shrinks to fit the size of the client window.

Definition at line 90 of file framewin.cpp.

References Init(), and owl::TWindow::Init().

TFrameWindow() [2/5]

owl::TFrameWindow::TFrameWindow	(	TWindow *	parent,
		const tstring &	title,
		TWindow *	client = nullptr,
		bool	shrinkToClient = false,
		TModule *	module = nullptr )

String-aware overload.

Definition at line 108 of file framewin.cpp.

References Init(), and owl::TWindow::Init().

TFrameWindow() [3/5]

owl::TFrameWindow::TFrameWindow	(	TWindow *	parent,
		const tstring &	title,
		std::unique_ptr< TWindow >	client = nullptr,
		bool	shrinkToClient = false,
		TModule *	module = nullptr )

Smart-pointer-aware overload.

Definition at line 123 of file framewin.cpp.

References Init(), and owl::TWindow::Init().

TFrameWindow() [4/5]

owl::TFrameWindow::TFrameWindow	(	HWND	THandle,
		TModule *	module = nullptr )

Constructor for a TFrameWindow that is being used as an alias for a non-ObjectWindows window.

hWnd is the handle to the existing window object that TFrameWindow controls; module contains the module passed to the base class's contructor.

This constructor is generally not used by derived classes, only as generic alias to a framewindow-like HWND

Definition at line 140 of file framewin.cpp.

References Init().

~TFrameWindow()

owl::TFrameWindow::~TFrameWindow ( )

override

Destructor for a TFrameWindow.

Deletes any associated menu descriptor.

Definition at line 220 of file framewin.cpp.

References owl::TApplication::ClearMainWindow(), owl::TWindow::GetApplication(), owl::TWindow::IsFlagSet(), and owl::wfMainWindow.

TFrameWindow() [5/5]

owl::TFrameWindow::TFrameWindow ( )

protected

< String-aware overload

Protected constructor for use by immediate virtually derived classes.

Immediate derivitives must call Init() before constructions are done.

Definition at line 151 of file framewin.cpp.

Member Function Documentation

AssignMenu()

bool owl::TFrameWindow::AssignMenu ( TResId menuResId )

virtual

Perform a high-level menu assignment either before or after the HWND for the window has been created.

Sets Attr.Menu to the supplied menuResId and frees any previous strings pointed to by Attr.Menu. If HWindow is nonzero, loads and sets the menu of the window, destroying any previously existing menu.

Returns true if successful; false otherwise

Definition at line 491 of file framewin.cpp.

References owl::TWindow::GetHandle(), owl::TWindow::GetMenu(), owl::TWindow::LoadMenu(), SetMenu(), and strnewdup().

BroadcastResizeToChildren()

void owl::TFrameWindow::BroadcastResizeToChildren ( uint sizeType, const TSize & size )

protected

Tell child windows frame has minimized/maximized/restored (They may want to change enabled state or release/restore resources)

Definition at line 1122 of file framewin.cpp.

References owl::TWindow::ChildBroadcastMessage(), and WM_OWLFRAMESIZE.

CleanupWindow()

void owl::TFrameWindow::CleanupWindow ( )

overrideprotectedvirtual

Cleans up any associated icons.

Reimplemented from owl::TWindow.

Reimplemented in ocf::TOleFrame, and owl::TTraceWindow.

Definition at line 1107 of file framewin.cpp.

References owl::TWindow::CleanupWindow(), SetIcon(), and SetIconSm().

EnableKBHandler()

void owl::TFrameWindow::EnableKBHandler ( )

inline

Sets the keyboard handling flag to true.

Sets a flag indicating that the receiver has requested keyboard navigation (translation of keyboard input into control selections). By default, the keyboard interface, which lets users use the tab and arrow keys to move between the controls, is disabled for windows and dialog boxes.

Definition at line 372 of file framewin.h.

References SetKeyboardHandling().

EvCommand()

TResult owl::TFrameWindow::EvCommand ( uint id, HWND hWndCtl, uint notifyCode ) -> TResult

overrideprotectedvirtual

Handle WM_COMMAND to provide extra processing for commands: Extra processing for commands: starts with the command target window (usually the focus window) and gives it and its parent windows an opportunity to handle the command.

Reimplemented from owl::TWindow.

Definition at line 387 of file framewin.cpp.

References owl::TWindow::EvCommand(), GetCommandTarget(), owl::TWindow::GetHandle(), owl::TWindow::GetParent(), owl::TWindow::GetWindowPtr(), and TRACEX.

EvCommandEnable()

void owl::TFrameWindow::EvCommandEnable ( TCommandEnabler & commandEnabler )

overrideprotectedvirtual

Handle WM_COMMAND_ENABLE to provide command enable distribution and default support for windows without command enable handlers.

Handles checking and unchecking of the frame window's menu items. EvCommandEnable uses TWindow's RouteCommandEnable member function to perform the majority of this command enabling work.

Reimplemented from owl::TWindow.

Definition at line 423 of file framewin.cpp.

References GetCommandTarget(), and owl::TWindow::RouteCommandEnable().

EvInitMenuPopup()

void owl::TFrameWindow::EvInitMenuPopup ( HMENU hPopupMenu, uint index, bool isSysMenu )

protected

Responds to WM_INITMENUPOPUP by performing a command enable run on each of the menu items in the popup menu.

Sent before a pop-up menu is displayed, EvInitMenuPopup lets an application change the items on the menu before the menu is displayed. EvInitMenuPopup controls whether the items on the pop-up menu are enabled or disabled, checked or unchecked, or strings. HMENU indicates the menu handle. index is the index of the pop-up menu. sysMenu indicates if the pop-up menu is the system menu.

Definition at line 264 of file framewin.cpp.

References owl::TWindow::DrawMenuBar(), owl::TWindow::EvInitMenuPopup(), and owl::TWindow::GetMenu().

EvPaletteChanged()

void owl::TFrameWindow::EvPaletteChanged ( HWND hWndPalChg )

protected

Forwards the WM_PALETTECHANGED message to the client window.

Definition at line 918 of file framewin.cpp.

References owl::TWindow::EvPaletteChanged(), and GetClientWindow().

EvParentNotify()

void owl::TFrameWindow::EvParentNotify ( const TParentNotify & n )

protected

Responds to a message to notify the parent window that a given event has occurred.

If the client window is destroyed, closes the parent window. If shrinkToClient is set and the child window has changed size, the frame is adjusted. When a TFrameWindow's client window is destroyed, the TFrameWindow object sees the WM_PARENTNOTIFY message and posts a close message to itself. Without this message, an empty frame would remain and the client window would then have to determine how to destroy the frame. If you don't want this to happen, you can derive from the frame window and have your application handle the EvParentNotify or EvClose messages.

Definition at line 876 of file framewin.cpp.

References owl::TWindow::DefaultProcessing(), owl::TWindow::GetHandle(), owl::TWindow::GetWindowPtr(), owl::TWindow::IsFlagSet(), owl::TWindow::IsIconic(), owl::TWindow::PostMessage(), owl::wfFullyCreated, and owl::wfShrinkToClient.

EvQueryDragIcon()

HICON owl::TFrameWindow::EvQueryDragIcon ( )

protected

Responds to a WM_QUERYDRAGICON message sent to a minimized (iconic) window that is going to be dragged.

Instead of the default icon, EvQueryDragIcon uses the icon that was set using SetIcon. This member is not available under Presentation Manager.

Definition at line 738 of file framewin.cpp.

References owl::TWindow::EvQueryDragIcon(), and owl::TUser::LoadIcon().

EvQueryNewPalette()

bool owl::TFrameWindow::EvQueryNewPalette ( )

protected

Forwards the WM_QUERYNEWPALETTE message to the client window.

Definition at line 906 of file framewin.cpp.

References owl::TWindow::EvQueryNewPalette(), and GetClientWindow().

EvSetFocus()

void owl::TFrameWindow::EvSetFocus ( HWND hWndLostFocus )

protected

Restores the focus to the active window.

hWndLostFocus contains the handle for the window that lost focus.

Handle WM_SETFOCUS to return focus back to the child that had it most recently, or find the best one to give it to otherwise.

Definition at line 840 of file framewin.cpp.

References owl::TWindow::EvSetFocus(), GetCommandTarget(), owl::TWindow::IsChild(), owl::TWindow::IsWindow(), and owl::TWindow::SetFocus().

EvSize()

void owl::TFrameWindow::EvSize ( uint sizeType, const TSize & size )

protected

Response method for an incoming WM_SIZE message.

Resizes the client window' so that it is equivalent to the client rectangle's size. Calls TWindow::EvSize() in response to an incoming WM_SIZE message.

If no WM_SIZE sent, forwards WM_SIZE message to client so it can recalc.

Definition at line 1141 of file framewin.cpp.

References BroadcastResizeToChildren(), owl::TWindow::EvSize(), owl::TWindow::ForwardMessage(), and owl::TWindow::GetClientRect().

GetBarDescr()

const TBarDescr * owl::TFrameWindow::GetBarDescr ( ) const

inline

Returns a pointer to the control bar descriptor.

Definition at line 324 of file framewin.h.

GetClientWindow()

TWindow * owl::TFrameWindow::GetClientWindow ( )

virtual

Returns a pointer to the client window.

If you are trying to access a window-based object in a TMDIChild (which is a frame window), you can use this function.

Reimplemented in owl::TMDIFrame.

Definition at line 591 of file framewin.cpp.

GetCommandTarget()

HWND owl::TFrameWindow::GetCommandTarget ( )

virtual

Locates and returns the child window that is the target of the command and command enable messages.

If the current application does not have focus or if the focus is within a toolbar in the application, GetCommandTarget returns the most recently active child window.

If an alternative form of command processing is desired, a user's main window class can override this function. TFrameWindow's EvCommand and EvCommandEnable functions use GetCommandTarget to find the command target window. This member is not available under Presentation Manager.

Reimplemented in owl::TFloatingFrame, and owl::TMDIFrame.

Definition at line 328 of file framewin.cpp.

References GetClientWindow(), owl::TWindow::GetFocus(), owl::TWindow::GetWindowPtr(), owl::TWindow::IsChild(), and TRACEX.

GetDocTitleIndex()

int owl::TFrameWindow::GetDocTitleIndex ( ) const

inlineprotected

Returns the document title index.

Definition at line 396 of file framewin.h.

GetHWndRestoreFocus()

HWND owl::TFrameWindow::GetHWndRestoreFocus ( )

inlineprotected

Returns the handle of the window to restore the focus to.

Definition at line 380 of file framewin.h.

GetIcon()

HICON owl::TFrameWindow::GetIcon ( ) const

inline

Retrieve handle of icon of frame window.

Note

Only retrieves icon set via the 'SetIcon' API - does not retrieve the small HICON associated with the HWND.

Definition at line 298 of file framewin.h.

GetIconSm()

HICON owl::TFrameWindow::GetIconSm ( ) const

inline

Retrieve handle of icon of frame window.

Note

Only retrieves icon set via the 'SetIconSm' API - does not retrieve the HICON associated with the HWND.

Definition at line 308 of file framewin.h.

GetKeyboardHandling()

bool owl::TFrameWindow::GetKeyboardHandling ( ) const

inline

Returns flag indicating that the receiver has requested "keyboard handling" (translation of keyboard input into control selections).

Definition at line 350 of file framewin.h.

GetMenuDescr()

const TMenuDescr * owl::TFrameWindow::GetMenuDescr ( ) const

inline

Returns a pointer to the menu descriptor for the frame window.

Definition at line 316 of file framewin.h.

GetMergeModule()

TModule * owl::TFrameWindow::GetMergeModule ( )

inline

Returns the module of the merge menu.

Definition at line 412 of file framewin.h.

HoldFocusHWnd()

bool owl::TFrameWindow::HoldFocusHWnd ( HWND hWndLose, HWND hWndGain ) -> bool

overridevirtual

Overrides TWindow's virtual function.

Responds to a request by a child window to hold its HWND when it is losing focus. Stores the child's HWND in HwndRestoreFocus.

return true if caller can stop searching for a window to hold its handle.

Reimplemented from owl::TWindow.

Definition at line 822 of file framewin.cpp.

References owl::TWindow::GetHandle(), and owl::TWindow::IsChild().

IdleAction()

bool owl::TFrameWindow::IdleAction ( long idleCount ) -> bool

overridevirtual

Overrides TWindow's virtual function.

TApplication calls the main window's IdleAction when no messages are waiting to be processed. TFrameWindow uses this idle time to perform command enabling for the menu bar. It also forwards IdleAction to each of its children. IdleAction can be overridden to do background processing.

Reimplemented from owl::TWindow.

Reimplemented in owl::TTraceWindow.

Definition at line 293 of file framewin.cpp.

References owl::TWindow::GetFocus(), owl::TWindow::GetMenu(), owl::TWindow::GetWindowLong(), owl::TWindow::HandleMessage(), owl::TWindow::IdleAction(), and owl::TWindow::IsWindow().

Init()

void owl::TFrameWindow::Init ( TWindow * clientWnd, bool shrinkToClient )

protected

Normal initialization of a default constructed TFrameWindow.

Is ignored if called more than once.

This initialize function is for use with virtually derived classes, which must call Init before construction is completed. This procedure provides necessary data to virtually derived classes and takes care of providing the data in the appropriate sequence.

Definition at line 166 of file framewin.cpp.

References Init(), owl::TWindow::SetFlag(), and owl::wfShrinkToClient.

MergeBar()

bool owl::TFrameWindow::MergeBar ( const TBarDescr & childBarDescr )

inlinevirtual

Do nothing. Return false. Overriden in TDecoratedFrame.

Reimplemented in owl::TDecoratedFrame.

Definition at line 333 of file framewin.h.

MergeMenu()

bool owl::TFrameWindow::MergeMenu ( const TMenuDescr & childMenuDescr )

virtual

Merges the given menu descriptor with this frame's own menu descriptor and displays the resulting menu in this frame.

See TMenuDescr for a description of menu bar types that can be merged.

Optionally use an existing HMENU to merge into & set

Definition at line 1204 of file framewin.cpp.

References owl::TWindow::GetApplication(), owl::TWindow::GetHandle(), owl::TWindow::IsFlagSet(), owl::TMenuDescr::Merge(), owl::NoAutoDelete, owl::TApplication::PreProcessMenu(), SetMenu(), and owl::wfMainWindow.

PreProcessMsg()

bool owl::TFrameWindow::PreProcessMsg ( MSG & msg ) -> bool

overridevirtual

Overrides TWindow's virtual function.

Performs preprocessing of window messages. If the child window has requested keyboard navigation, PreProcessMsg handles any accelerator key messages and then processes any other keyboard messages.

Reimplemented from owl::TWindow.

Reimplemented in owl::TMDIChild.

Definition at line 436 of file framewin.cpp.

References _T, _tcsicmp, COUNTOF, owl::TWindow::GetParent(), and owl::TWindow::PreProcessMsg().

RemoveChild()

void owl::TFrameWindow::RemoveChild ( TWindow * child )

overridevirtual

If someone removes our client with a RemoveChild() call, update our client and restore focus ptrs.

Reimplemented from owl::TWindow.

Definition at line 652 of file framewin.cpp.

References owl::TWindow::RemoveChild().

RestoreBar()

bool owl::TFrameWindow::RestoreBar ( )

inlinevirtual

Do nothing in TFrameWindow. Overriden in TDecoratedFrame.

Reimplemented in owl::TDecoratedFrame.

Definition at line 341 of file framewin.h.

RestoreMenu()

bool owl::TFrameWindow::RestoreMenu

(

)

Definition at line 1235 of file framewin.cpp.

References owl::TWindow::GetMenu(), owl::NoAutoDelete, and SetMenu().

SetBarDescr()

void owl::TFrameWindow::SetBarDescr	(	TBarDescr *	barDescr,
		TAutoDelete	delonClose = AutoDelete )

Sets the control bar descriptor to the new bar descriptor.

Definition at line 1186 of file framewin.cpp.

References owl::AutoDelete, owl::TWindow::GetHandle(), owl::TWindow::IsFlagSet(), RestoreBar(), and owl::wfMainWindow.

SetClientWindow() [1/2]

auto owl::TFrameWindow::SetClientWindow

(

std::unique_ptr< TWindow >

c

)

-> std::unique_ptr<TWindow>

Smart-pointer-aware overload.

Definition at line 640 of file framewin.cpp.

SetClientWindow() [2/2]

TWindow * owl::TFrameWindow::SetClientWindow ( TWindow * clientWnd )

virtual

Sets the client window to the specified window.

Users are responsible for destroying the old client window if they want to eliminate it.

Assume clientWnd was parented to us.

Reimplemented in owl::TDecoratedFrame, and owl::TDecoratedFrame.

Definition at line 603 of file framewin.cpp.

References owl::TWindow::Create(), owl::TWindow::GetFocus(), owl::TWindow::GetHandle(), NoColor, NoErase, RemoveChild(), owl::TWindow::SetBkgndColor(), owl::TWindow::SetFocus(), owl::TWindow::SetParent(), and owl::TWindow::ShowWindow().

SetDocTitle() [1/3]

bool owl::TWindow::SetDocTitle ( const tstring & docname, int index )

inline

Definition at line 693 of file window.h.

SetDocTitle() [2/3]

bool owl::TWindow::SetDocTitle ( LPCTSTR docname, int index )

virtual

Default behavior for updating document title is to pass it to parent frame.

Stores the title of the document (docname). index is the number of the view displayed in the document's caption bar. In order to determine what the view number should be, SetDocTitle makes two passes: the first pass checks to see if there's more than one view, and the second pass, if there is more than one view, assigns the next number to the view. If there is only one view, index is 0; therefore, the document does not display a view number. When TDocument is checking to see if more than one view exists, index is -1. In such cases, only the document's title is displayed in the caption bar. SetDocTitle returns true if there is more than one view and TDocument displays the number of the view passed in index.

Reimplemented from owl::TWindow.

Definition at line 692 of file window.cpp.

SetDocTitle() [3/3]

bool owl::TFrameWindow::SetDocTitle ( LPCTSTR docname, int index ) -> bool

overridevirtual

Overrides TWindow's virtual function.

Pastes the number of the view into the caption and then shows the number on the screen. This function can be overridden if you don't want to use the default implementation, which displays a number on the screen. That is, you might want to write "Two" instead of ":2" on the screen. For an example of the behavior of this function, see step 12 of the ObjectWindows tutorial, which renumbers the views if one of them is closed.

Generates a composite title based on the caption, docname, and index if it is > 0.

[<Title> - ]<docname>[:<index>]

Reimplemented from owl::TWindow.

Definition at line 679 of file framewin.cpp.

References _stprintf, _T, owl::TWindow::GetCaption(), and owl::TWindow::SetWindowText().

SetDocTitleIndex()

void owl::TFrameWindow::SetDocTitleIndex ( int index )

inlineprotected

Sets the current document's title index.

Definition at line 404 of file framewin.h.

SetHWndRestoreFocus()

void owl::TFrameWindow::SetHWndRestoreFocus ( HWND hwndRestoreFocus )

inlineprotected

Sets the remembered focused window.

Definition at line 388 of file framewin.h.

SetIcon()

bool owl::TFrameWindow::SetIcon	(	TModule *	module,
		TResId	resId )

Sets the icon in the module specified in iconModule to the resource ID specified in iconResId.

See the sample file BMPVIEW.CPP for an example of painting an icon from a bitmap. You can set the iconResId to one of these predefined values as well as user-defined values:

• IDI_APPLICATION Default icon used for applications
• IDI_ASTERISK Asterisk used for an informative message
• IDI_EXCLAMATION Exclamation mark used for a warning message
• IDI_HAND Hand used for warning messages
• IDI_QUESTION Question mark used for prompting a response

Definition at line 531 of file framewin.cpp.

References owl::TUser::DestroyIcon(), owl::TWindow::IsWindow(), owl::TUser::LoadIcon(), owl::TWindow::SendMessage(), and WM_SETICON.

SetIconSm()

bool owl::TFrameWindow::SetIconSm	(	TModule *	iconModule,
		TResId	iconResIdSm )

Set the Small Icon (16 x 16)

Definition at line 558 of file framewin.cpp.

References owl::TUIMetric::CxSmIcon, owl::TUIMetric::CySmIcon, owl::TUser::DestroyIcon(), owl::TResIdT< T >::GetPointerRepresentation(), owl::TWindow::IsWindow(), owl::TUser::LoadIcon(), owl::TWindow::SendMessage(), and WM_SETICON.

SetKeyboardHandling()

void owl::TFrameWindow::SetKeyboardHandling ( bool kh = true )

inline

Sets flag indicating that the receiver has requested "keyboard handling" (translation of keyboard input into control selections).

Definition at line 359 of file framewin.h.

SetMenu()

bool owl::TFrameWindow::SetMenu ( HMENU newMenu )

virtual

Overrides TWindow's non-virtual SetMenu function, thus allowing derived classes the opportunity to implement this function differently from TWindow.

SetMenu sets the window's menu to the menu indicated by newMenu. If newMenu is 0, the window's current menu is removed. SetMenu returns 0 if the menu remains unchanged; otherwise, it returns a nonzero value.

It also calls the application's PreProcessMenu() if it is the main window to let it make any changes just before setting.

Reimplemented in owl::TMDIFrame.

Definition at line 471 of file framewin.cpp.

References owl::TWindow::GetApplication(), owl::TWindow::IsFlagSet(), owl::TApplication::PreProcessMenu(), owl::TWindow::SetMenu(), and owl::wfMainWindow.

SetMenuDescr()

void owl::TFrameWindow::SetMenuDescr

(

const TMenuDescr &

menuDescr

)

Sets the menu descriptor to the new menu descriptor.

Definition at line 1164 of file framewin.cpp.

References owl::TWindow::GetHandle(), owl::TWindow::GetMenu(), owl::TWindow::IsFlagSet(), owl::NoAutoDelete, SetMenu(), and owl::wfMainWindow.

SetMergeModule()

void owl::TFrameWindow::SetMergeModule ( TModule * module )

inlineprotected

Remembers where the merged menu came from.

Definition at line 420 of file framewin.h.

SetupWindow()

void owl::TFrameWindow::SetupWindow ( )

overrideprotectedvirtual

Calls TWindow::SetUpWindow to create windows in a child list.

SetupWindow performs the initial adjustment of the client window if one exists, assigns the frame's menu based on the menu descriptor, and initializes HwndRestoreFocus.

TH Previous version would be to search for first child with tabstop. TH Why not use CommandTarget?

Reimplemented from owl::TWindow.

Reimplemented in ocf::TOleFrame, owl::TPreviewWin, and owl::TTraceWindow.

Definition at line 1050 of file framewin.cpp.

References GetCommandTarget(), owl::TWindow::GetHandle(), owl::TWindow::GetMenu(), owl::TWindow::GetWindowPlacement(), owl::TWindow::IsChild(), owl::TWindow::IsFlagSet(), owl::NoAutoDelete, owl::TWindow::SendMessage(), SetMenu(), owl::TWindow::SetupWindow(), owl::TWindow::SetWindowPlacement(), owl::wfMainWindow, and WM_SETICON.

---

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

• include/owl/framewin.h
• source/owlcore/framewin.cpp