Derived from TWindow, TGadgetWindow maintains a list of tiled gadgets for a window and lets you dynamically arrange tool bars. More...

#include <owl/gadgetwi.h>

Inheritance diagram for owl::TGadgetWindow:

Classes
class	TLayoutInfo
	Gadget layout information used during the layout process. More...

Public Types
enum	TTileDirection { Horizontal , Vertical , Rectangular }
	Enumeration describing how gadgets should be laid out within the gadget window. More...

enum	THintMode { NoHints , PressHints , EnterHints }
	Hint mode settings & action used by contained gadgets. More...

enum	TFlatStyle { NonFlatNormal = 0x0000L , FlatStandard = 0x0001L , FlatGrayButtons = 0x0002L , FlatHotText = 0x0004L , FlatSingleDiv = 0x0008L , FlatXPTheme = 0x0010L , FlatDefault = 0xFFFFL }
	Enumerates the flat styles settings of the gadget. More...

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 &)

Public Types inherited from owl::TGadgetList
enum	TPlacement { Before , After }
	Enumerates the placement of a gadget. More...

Public Member Functions
	TGadgetWindow (TWindow parent=nullptr, TTileDirection direction=Horizontal, TFont font=nullptr, TModule *module=nullptr)
	Creates a TGadgetWindow interface object with the default tile direction and font and passes module with a default value of 0.

	~TGadgetWindow () override
	Destructs this gadget window.

auto	Create () -> bool override
	Overrides TWindow member function and chooses the initial size of the gadget if shrink-wrapping was requested.

void	SetMargins (const TMargins &margins)
	Sets or changes the margins for the gadget window and calls LayoutSession().

TMargins &	GetMargins ()

const TMargins &	GetMargins () const

TTileDirection	GetDirection () const
	Returns the direction of tiling for this gadget window.

virtual void	SetDirection (TTileDirection direction)
	Sets the horizontal or vertical orientation of the gadgets.

void	SetRectangularDimensions (int width, int height, int rowMargin=-1)
	Sets the maximum width for each row used for rectangular layout.

const TFont &	GetFont () const
	Returns the font being used by this gadget window.

uint	GetFontHeight () const
	Returns the height of the font being used by this gadget window.

auto	GetTooltip () const -> TTooltip *override
	Returns Tooltip.

void	EnableTooltip (bool enable=true) override

void	SetTooltip (TTooltip *tooltip)
	Sets the Tooltip data member equal to tooltip.

bool	GetWantTooltip () const

void	SetWantTooltip (bool wantTooltip)

bool	GadgetSetCapture (TGadget &gadget)
	Called by a gadget that wants to capture the mouse.

void	GadgetReleaseCapture (TGadget &gadget)
	Releases the capture so that other windows can receive mouse messages.

TGadget *	GadgetGetCaptured ()
	Retrieves gadget with capture.

void	SetHintMode (THintMode hintMode)
	Sets the mode of the hint text.

THintMode	GetHintMode ()
	Returns the current hint mode of this gadget window.

void	SetHintCommand (int id)
	(id <= 0) to clear

bool	IsThemed () const

void	EnableThemeBackground (bool enable=true)

bool	IsThemeBackgroundEnabled () const

bool	IsBackgroundThemed () const

void	Insert (TGadget &, TPlacement=After, TGadget *sibling=nullptr) override
	Inserts a gadget before or after a sibling gadget (TPlacement).

void	InsertFrom (TGadgetList &, TPlacement=After, TGadget *sibling=nullptr) override
	Inserts a list of Gadgets.

auto	Remove (TGadget &) -> TGadget *override
	Removes a gadget from the gadget window.

void	Inserted (TGadget &) override
	A gadget has been inserted into this gadget window.

void	Removed (TGadget &) override
	This indicates that a gadget has been removed from this gadget window.

virtual void	SetCelArray (TCelArray *sharedCels)
	Sets a new Shared CelArray for this gadget window.

virtual TCelArray &	GetCelArray (int minX=0, int minY=0)
	Gets the Shared CelArray for this gadget window.

auto	IdleAction (long idleCount) -> bool override
	During idle time, iterates over the Gadgets invoking their CommandEnable() member function.

bool	EnableTimer ()
	Inform GadgetWindow to start a Timer notification.

void	GadgetChangedSize (TGadget &gadget)
	Used to notify the gadget window that a gadget has changed its size, GadgetChangedSize calls LayoutSession() to re-layout all gadgets.

virtual void	LayoutSession ()
	LayoutSession is typically called when a change occurs in the size of the margins or gadgets, or when gadgets are added or deleted.

void	SetShrinkWrap (bool shrinkWrapWidth, bool shrinkWrapHeight)
	Sets the width and height of the data members.

virtual void	GetDesiredSize (TSize &size)
	Get the desired size for this gadget window by performing a trial layout of the gadgets without touching them.

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.

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.

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

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	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.

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.

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)

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 ()

Public Member Functions inherited from owl::TGadgetList
	TGadgetList ()

virtual	~TGadgetList ()

uint	GadgetCount () const
	Returns the number of gadgets in the list.

TGadget *	FirstGadget () const
	Returns the first gadget of the list.

TGadget *	NextGadget (TGadget &gadget) const
	Returns the next gadget in the list relative to a given gadget.

TGadget *	GadgetFromPoint (const TPoint &point) const
	Returns the gadget that a given window-relative point is in, or 0 if none is found.

TGadget *	GadgetWithId (int id) const
	Returns the gadget with a given ID, or 0 if none is found.

TGadget *	operator[] (uint index)
	Returns gadget at a given index.

Static Public Member Functions
static void	EnableFlatStyle (uint style=FlatDefault)
	Set flat style options, or disable it.

static uint	GetFlatStyle ()
	Returns the flat style.

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 ()

Protected Member Functions
virtual void	PaintGadgets (TDC &dc, bool erase, TRect &rect)
	Called by Paint to repaint all of the gadgets, PaintGadgets iterates through the list of gadgets, determines the gadget's area, and repaints each gadget.

virtual void	GetInnerRect (TRect &rect)
	GetInnerRect computes the rectangle inside of the borders and margins of the gadget.

int	LayoutUnitsToPixels (int units)
	Converts layout units to pixels.

void	GetMargins (const TMargins &margins, int &left, int &right, int &top, int &bottom)
	Retrieve the sizes of the 4 margins in pixels for this gadget window given a margin object.

void	UseDesiredSize ()
	Updates the Size in Attr.W and Attr.H to match that obtained using GetDesiredSize() for each dimension that is shrink-wrapped.

virtual void	LayoutGadgets (TTileDirection dir, TLayoutInfo &layout)
	Calculate the layout of the Gadgets in a given direction.

virtual TRect	TileGadgets ()
	Tiles the Gadgets in the current direction.

void	Paint (TDC &, bool erase, TRect &) override
	Puts the font into the device context and calls PaintGadgets.

virtual void	PositionGadget (TGadget previous, TGadget next, TPoint &point)
	Virtual called by TileGadgets() for each gadget in order to give derived classes a chance to modify the gadget positioning.

void	SetupWindow () override
	Overrides TWindow::SetupWindow to create tooltips for the gadget window.

void	CleanupWindow () override

bool	PreProcessMsg (MSG &msg) override
	Relays 'interesting' messages to the tooltip window.

void	EvLButtonDown (uint modKeys, const TPoint &point)
	Responds to a left button-down mouse message by forwarding the event to the gadget (if it is enabled) positioned under the mouse.

void	EvLButtonUp (uint modKeys, const TPoint &point)
	Responds to a left button-up mouse message by forwarding the event to the gadget that has the capture or to the gadget positioned under the mouse.

void	EvLButtonDblClk (uint modKeys, const TPoint &point)
	Passes double clicks through as if they were just a second click; finishes the first click, and begins the second: Dn + Dbl + Up -> Dn + Up+Dn + Up.

void	EvRButtonDown (uint modKeys, const TPoint &point)
	Pass RButton messages to the gadget at the mouse location or the one with Capture.

void	EvRButtonUp (uint modKeys, const TPoint &point)
	Pass RButton messages to the gadget at the mouse location or the one with capture.

void	EvMouseMove (uint modKeys, const TPoint &point)
	Forward mouse moves to the gadget that has captured the mouse, if any.

bool	EvWindowPosChanging (WINDOWPOS &windowPos)
	Intercepts window size changes to make sure that this gadget window follows its own sizing rules.

void	EvSysColorChange ()
	Responds to WM_SYSCOLORCHANGE to let the gadgets update their UI colors, and to let this gadget window update its background color.

bool	EvEraseBkgnd (HDC)

void	EvCreateTooltips ()

auto	EvCommand (uint id, HWND hWndCtl, uint notifyCode) -> TResult override
	When the gadget window receives a WM_COMMAND message, it is likely from a gadget or control within a TControlGadget.

void	EvCommandEnable (TCommandEnabler &) override
	When the gadget window receives a WM_COMMAND_ENABLE message, it is likely from a gadget or control within a TControlGadget.

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.

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.

Friends
class	TGadget

Additional Inherited Members
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, TGadgetWindow maintains a list of tiled gadgets for a window and lets you dynamically arrange tool bars.

You can specify the following attributes of these gadgets:

Horizontal or vertical tiling. Positions the gadgets horizontally or vertically within the inner rectangle (the area excluding borders and margins).
Gadget font. Default font to use for gadgets and for calculating layout units. For font information, see the description of TGadgetWindowFont.
Left, right, top, and bottom margins. Specified in pixels, layout units (based on the window font), or border units (the width or height of a thin window border).
Measurement units. Specified in pixels, layout units, or border units.
Gadget window size. A gadget window can shrink-wrap its width, height, or both to fit around its gadgets. By default, horizontally tiled gadgets shrink-wrap to fit the height of the window and vertically tiled gadgets shrink-wrap to fit the width of the window.

TGadgetWindow is the base class for the following derived classes: TControlBar, TMessageBar, TToolBox, and TStatusBar.

Definition at line 122 of file gadgetwi.h.

Member Enumeration Documentation

◆ TFlatStyle

enum owl::TGadgetWindow::TFlatStyle

Enumerates the flat styles settings of the gadget.

Enumerator
NonFlatNormal	No Flat style - default.
FlatStandard	Flat style IE 3.0 - base style.
FlatGrayButtons	Adds Gray buttons effect to FlatStandard.
FlatHotText	Adds hot text effect like.
FlatSingleDiv	Adds single divider ala IE 4.01.
FlatXPTheme	Windows XP theme styles.
FlatDefault	System automatically select apropriated style.

Definition at line 192 of file gadgetwi.h.

◆ THintMode

enum owl::TGadgetWindow::THintMode

Hint mode settings & action used by contained gadgets.

Enumerator
NoHints	No hints.
PressHints	Hints when a button is pressed.
EnterHints	Hints when the mouse passes over a gadget.

Definition at line 182 of file gadgetwi.h.

◆ TTileDirection

enum owl::TGadgetWindow::TTileDirection

Enumeration describing how gadgets should be laid out within the gadget window.

TGadgetWindow::TileGadgets actually tiles the gadgets in the direction requested.

Enumerator
Horizontal	Arrange gadgets in a row.
Vertical	Arrange gadgets in a column.
Rectangular	Arrange gadgets in rows and columns (2-D grid)

Definition at line 130 of file gadgetwi.h.

Constructor & Destructor Documentation

◆ TGadgetWindow()

owl::TGadgetWindow::TGadgetWindow	(	TWindow *	parent = nullptr,
		TTileDirection	direction = Horizontal,
		TFont *	font = nullptr,
		TModule *	module = nullptr )

Creates a TGadgetWindow interface object with the default tile direction and font and passes module with a default value of 0.

Definition at line 98 of file gadgetwi.cpp.

References owl::TUIMetric::CyBorder, owl::TFont::GetTextMetrics(), Horizontal, owl::TWindow::Init(), owl::TWindow::ModifyStyle(), PressHints, owl::TWindow::SetBkgndColor(), owl::TColor::Sys3dFace, and Vertical.

◆ ~TGadgetWindow()

owl::TGadgetWindow::~TGadgetWindow ( )

override

Destructs this gadget window.

Deletes the gadgets, the font and the shared cel array

Definition at line 166 of file gadgetwi.cpp.

Member Function Documentation

◆ CleanupWindow()

void owl::TGadgetWindow::CleanupWindow ( )

overrideprotectedvirtual

Reimplemented from owl::TWindow.

Definition at line 1205 of file gadgetwi.cpp.

References owl::TWindow::CleanupWindow(), owl::TWindow::KillTimer(), and owl::TGadget::MouseLeave().

◆ Create()

bool owl::TGadgetWindow::Create ( ) -> bool

overridevirtual

Overrides TWindow member function and chooses the initial size of the gadget if shrink-wrapping was requested.

Reimplemented from owl::TWindow.

Definition at line 429 of file gadgetwi.cpp.

References owl::TWindow::Create(), and UseDesiredSize().

◆ EnableFlatStyle()

void owl::TGadgetWindow::EnableFlatStyle ( uint style = FlatDefault )

static

Set flat style options, or disable it.

Definition at line 489 of file gadgetwi.cpp.

References FlatDefault, FlatGrayButtons, FlatHotText, FlatSingleDiv, FlatStandard, FlatXPTheme, and owl::GetCommCtrlVersion().

◆ EnableThemeBackground()

void owl::TGadgetWindow::EnableThemeBackground ( bool enable = true )

Definition at line 514 of file gadgetwi.cpp.

◆ EnableTimer()

bool owl::TGadgetWindow::EnableTimer ( )

Inform GadgetWindow to start a Timer notification.

Set timer - useful for gadgets that need regular update [Time/Date].

Note: TGadgetWindow does not catch the WM_TIMER event. The purpose of the timer message it to cause message dispatching which eventually leads to an 'IdleAction' call.

Definition at line 226 of file gadgetwi.cpp.

References owl::GadgetWindowTimeOut, owl::GadgetWindowTimerID, owl::TWindow::GetHandle(), and owl::TWindow::SetTimer().

◆ EnableTooltip()

void owl::TGadgetWindow::EnableTooltip ( bool enable = true )

overridevirtual

Reimplemented from owl::TWindow.

Definition at line 1522 of file gadgetwi.cpp.

References owl::TTooltip::Activate(), owl::TWindow::GetHandle(), SetTooltip(), and owl::wfMainWindow.

◆ EvCommand()

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

overrideprotectedvirtual

When the gadget window receives a WM_COMMAND message, it is likely from a gadget or control within a TControlGadget.

This reroutes it to the command target.

Reimplemented from owl::TWindow.

Definition at line 1595 of file gadgetwi.cpp.

References CHECK, owl::TEventHandler::Dispatch(), owl::TWindow::EvCommand(), owl::TEventHandler::Find(), owl::TFrameWindow::GetCommandTarget(), owl::TWindow::GetHandle(), owl::TWindow::GetParentO(), TRACEX, and TYPESAFE_DOWNCAST.

◆ EvCommandEnable()

void owl::TGadgetWindow::EvCommandEnable ( TCommandEnabler & ce )

overrideprotectedvirtual

When the gadget window receives a WM_COMMAND_ENABLE message, it is likely from a gadget or control within a TControlGadget.

This reroutes it to the command target.

Reimplemented from owl::TWindow.

Definition at line 1655 of file gadgetwi.cpp.

References CHECK, owl::TEventHandler::Dispatch(), owl::TWindow::EvCommandEnable(), owl::TEventHandler::Find(), owl::TWindow::GetParentO(), and WM_COMMAND_ENABLE.

◆ EvCreateTooltips()

void owl::TGadgetWindow::EvCreateTooltips ( )

protected

Definition at line 1250 of file gadgetwi.cpp.

References EnableTooltip().

◆ EvEraseBkgnd()

bool owl::TGadgetWindow::EvEraseBkgnd ( HDC dc )

protected

Definition at line 1344 of file gadgetwi.cpp.

References owl::TWindow::EvEraseBkgnd(), owl::TWindow::GetClientRect(), owl::TWindow::GetHandle(), and IsBackgroundThemed().

◆ EvLButtonDblClk()

void owl::TGadgetWindow::EvLButtonDblClk	(	uint	modKeys,
		const TPoint &	point )

protected

Passes double clicks through as if they were just a second click; finishes the first click, and begins the second: Dn + Dbl + Up -> Dn + Up+Dn + Up.

Definition at line 1438 of file gadgetwi.cpp.

References EvLButtonDown(), and EvLButtonUp().

◆ EvLButtonDown()

void owl::TGadgetWindow::EvLButtonDown	(	uint	modKeys,
		const TPoint &	point )

protected

Responds to a left button-down mouse message by forwarding the event to the gadget (if it is enabled) positioned under the mouse.

Definition at line 1405 of file gadgetwi.cpp.

References owl::TWindow::EvLButtonDown(), and owl::TGadgetList::GadgetFromPoint().

◆ EvLButtonUp()

void owl::TGadgetWindow::EvLButtonUp	(	uint	modKeys,
		const TPoint &	point )

protected

Responds to a left button-up mouse message by forwarding the event to the gadget that has the capture or to the gadget positioned under the mouse.

Definition at line 1422 of file gadgetwi.cpp.

References owl::TWindow::EvLButtonUp(), and owl::TGadgetList::GadgetFromPoint().

◆ EvMouseMove()

void owl::TGadgetWindow::EvMouseMove	(	uint	modKeys,
		const TPoint &	point )

protected

Forward mouse moves to the gadget that has captured the mouse, if any.

Otherwise checks for mouse entering and leaving gadgets. This could be enhanced by delaying mouse enter messages until the mouse has been in the same area for a while, or by looking ahead in the queue for mouse messages.

Definition at line 1490 of file gadgetwi.cpp.

References owl::TWindow::EvMouseMove(), owl::TGadgetList::GadgetFromPoint(), owl::TGadget::MouseEnter(), owl::TGadget::MouseLeave(), and owl::TGadget::MouseMove().

◆ EvRButtonDown()

void owl::TGadgetWindow::EvRButtonDown	(	uint	modKeys,
		const TPoint &	point )

protected

Pass RButton messages to the gadget at the mouse location or the one with Capture.

Note: The default right-mouse down handler of TGadget does NOT set capture

Definition at line 1452 of file gadgetwi.cpp.

References owl::TWindow::EvRButtonDown(), and owl::TGadgetList::GadgetFromPoint().

◆ EvRButtonUp()

void owl::TGadgetWindow::EvRButtonUp	(	uint	modKeys,
		const TPoint &	point )

protected

Pass RButton messages to the gadget at the mouse location or the one with capture.

Note: The default right-mouse down handler of TGadget does NOT set capture

Definition at line 1472 of file gadgetwi.cpp.

References owl::TWindow::EvRButtonUp(), and owl::TGadgetList::GadgetFromPoint().

◆ EvSysColorChange()

void owl::TGadgetWindow::EvSysColorChange ( )

protected

Responds to WM_SYSCOLORCHANGE to let the gadgets update their UI colors, and to let this gadget window update its background color.

Note: This is an obsolete function retained for compatibility. New TWindow, TColor, and other UI support makes this unecessary.

Definition at line 180 of file gadgetwi.cpp.

◆ EvWindowPosChanging()

bool owl::TGadgetWindow::EvWindowPosChanging ( WINDOWPOS & windowPos )

protected

Intercepts window size changes to make sure that this gadget window follows its own sizing rules.

Also gives it a chance to layout wide-as-possible gadgets.

Definition at line 1271 of file gadgetwi.cpp.

References owl::TWindow::EvWindowPosChanging(), owl::TWindow::Invalidate(), owl::TWindow::InvalidateRect(), IsBackgroundThemed(), TileGadgets(), and UseDesiredSize().

◆ GadgetChangedSize()

void owl::TGadgetWindow::GadgetChangedSize ( TGadget & gadget )

Used to notify the gadget window that a gadget has changed its size, GadgetChangedSize calls LayoutSession() to re-layout all gadgets.

Definition at line 1010 of file gadgetwi.cpp.

References LayoutSession().

◆ GadgetGetCaptured()

TGadget * owl::TGadgetWindow::GadgetGetCaptured ( )

inline

Retrieves gadget with capture.

Definition at line 476 of file gadgetwi.h.

◆ GadgetReleaseCapture()

void owl::TGadgetWindow::GadgetReleaseCapture ( TGadget & gadget )

Releases the capture so that other windows can receive mouse messages.

Ignores other gadgets

Definition at line 286 of file gadgetwi.cpp.

References owl::TWindow::ReleaseCapture().

◆ GadgetSetCapture()

bool owl::TGadgetWindow::GadgetSetCapture ( TGadget & gadget )

Called by a gadget that wants to capture the mouse.

GadgetSetCapture reserves all mouse messages for the gadget window until the capture is released. Although gadgets are always notified if a left button-down event occurs within the rectangle, the derived gadget class must call GadgetSetCapture if you want the gadget to be notified when a mouse drag and a mouse button-up event occurs.

Fails if already captured

Definition at line 268 of file gadgetwi.cpp.

References owl::TWindow::SetCapture().

◆ GetCelArray()

TCelArray & owl::TGadgetWindow::GetCelArray	(	int	minX = 0,
		int	minY = 0 )

virtual

Gets the Shared CelArray for this gadget window.

Makes an empty one "on the fly" if needed.

Definition at line 1141 of file gadgetwi.cpp.

◆ GetDesiredSize()

void owl::TGadgetWindow::GetDesiredSize ( TSize & size )

virtual

Get the desired size for this gadget window by performing a trial layout of the gadgets without touching them.

If shrink-wrapping was requested, GetDesiredSize returns the size needed to accommodate the borders and the margins of the widest and highest gadget; otherwise, it returns the width and height in the window's Attr structure.

If you want to leave extra room for a specific look (for example, a separator line between gadgets, a raised line, and so on), you can override this function. However, if you override GetDesiredSize(), you will probably also need to override GetInnerRect() to calculate your custom inner rectangle.

For Rectangular layout it is assumed that the EndOfRow gadgets are already Set.

Reimplemented in owl::TMessageBar, and owl::TToolBox.

Definition at line 380 of file gadgetwi.cpp.

References LayoutGadgets().

◆ GetDirection()

TGadgetWindow::TTileDirection owl::TGadgetWindow::GetDirection ( ) const

inline

Returns the direction of tiling for this gadget window.

Definition at line 416 of file gadgetwi.h.

◆ GetFlatStyle()

uint owl::TGadgetWindow::GetFlatStyle ( )

inlinestatic

Returns the flat style.

Definition at line 459 of file gadgetwi.h.

◆ GetFont()

const TFont & owl::TGadgetWindow::GetFont ( ) const

inline

Returns the font being used by this gadget window.

Definition at line 423 of file gadgetwi.h.

◆ GetFontHeight()

uint owl::TGadgetWindow::GetFontHeight ( ) const

inline

Returns the height of the font being used by this gadget window.

Definition at line 437 of file gadgetwi.h.

◆ GetHintMode()

TGadgetWindow::THintMode owl::TGadgetWindow::GetHintMode ( )

inline

Returns the current hint mode of this gadget window.

Definition at line 452 of file gadgetwi.h.

◆ GetInnerRect()

void owl::TGadgetWindow::GetInnerRect ( TRect & rect )

protectedvirtual

GetInnerRect computes the rectangle inside of the borders and margins of the gadget.

If you want to leave extra room for a specific look (for example, a separator line between gadgets, a raised line, and so on), you can override this function. If you override GetInnerRect, you will probably also need to override GetDesiredSize() to calculate your custom total size.

Reimplemented in owl::TMessageBar.

Definition at line 564 of file gadgetwi.cpp.

References owl::TUIMetric::CxBorder, owl::TUIMetric::CyBorder, and GetMargins().

◆ GetMargins() [1/3]

TMargins & owl::TGadgetWindow::GetMargins ( )

inline

Definition at line 481 of file gadgetwi.h.

◆ GetMargins() [2/3]

const TMargins & owl::TGadgetWindow::GetMargins ( ) const

inline

Definition at line 486 of file gadgetwi.h.

◆ GetMargins() [3/3]

void owl::TGadgetWindow::GetMargins	(	const TMargins &	margins,
		int &	left,
		int &	right,
		int &	top,
		int &	bottom )

inlineprotected

Retrieve the sizes of the 4 margins in pixels for this gadget window given a margin object.

Definition at line 467 of file gadgetwi.h.

◆ GetTooltip()

TTooltip * owl::TGadgetWindow::GetTooltip ( ) const -> TTooltip*

inlineoverridevirtual

Returns Tooltip.

Reimplemented from owl::TWindow.

Definition at line 430 of file gadgetwi.h.

◆ GetWantTooltip()

bool owl::TGadgetWindow::GetWantTooltip ( ) const

inline

Definition at line 491 of file gadgetwi.h.

◆ IdleAction()

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

overridevirtual

During idle time, iterates over the Gadgets invoking their CommandEnable() member function.

Also detects lost mouse up for fly-over hint mode.

Reimplemented from owl::TWindow.

Definition at line 191 of file gadgetwi.cpp.

References owl::TWindow::GetCursorPos(), owl::TWindow::GetHandle(), owl::TWindow::HandleMessage(), owl::TWindow::IdleAction(), owl::MkParam2(), and owl::TWindow::WindowFromPoint().

◆ Insert()

void owl::TGadgetWindow::Insert	(	TGadget &	gadget,
		TPlacement	placement = After,
		TGadget *	sibling = nullptr )

overridevirtual

Inserts a gadget before or after a sibling gadget (TPlacement).

If sibling is 0, then the new gadget is inserted at either the beginning or the end of the gadget list. If this window has already been created, LayoutSession() needs to be called after inserting gadgets.

Reimplemented from owl::TGadgetList.

Reimplemented in owl::TStatusBar, and owl::TToolBox.

Definition at line 1022 of file gadgetwi.cpp.

References owl::TGadgetList::Insert(), and UseDesiredSize().

◆ Inserted()

void owl::TGadgetWindow::Inserted ( TGadget & gadget )

overridevirtual

A gadget has been inserted into this gadget window.

Reimplemented from owl::TGadgetList.

Definition at line 1061 of file gadgetwi.cpp.

References owl::TWindow::GetHandle().

◆ InsertFrom()

void owl::TGadgetWindow::InsertFrom	(	TGadgetList &	_list,
		TPlacement	placement = After,
		TGadget *	sibling = nullptr )

overridevirtual

Inserts a list of Gadgets.

The caller needs to also call LayoutSession() after inserting gadgets if this window has already been created.

Reimplemented from owl::TGadgetList.

Definition at line 1043 of file gadgetwi.cpp.

References owl::TGadgetList::InsertFrom(), and UseDesiredSize().

◆ IsBackgroundThemed()

bool owl::TGadgetWindow::IsBackgroundThemed ( ) const

Definition at line 532 of file gadgetwi.cpp.

References IsThemeBackgroundEnabled(), and IsThemed().

◆ IsThemeBackgroundEnabled()

bool owl::TGadgetWindow::IsThemeBackgroundEnabled ( ) const

Definition at line 523 of file gadgetwi.cpp.

◆ IsThemed()

bool owl::TGadgetWindow::IsThemed ( ) const

Definition at line 505 of file gadgetwi.cpp.

References FlatXPTheme, and owl::TThemeModule::GetInstance().

◆ LayoutGadgets()

void owl::TGadgetWindow::LayoutGadgets	(	TTileDirection	dir,
		TLayoutInfo &	layout )

protectedvirtual

Calculate the layout of the Gadgets in a given direction.

Definition at line 988 of file gadgetwi.cpp.

References CHECK, Horizontal, Rectangular, and Vertical.

◆ LayoutSession()

void owl::TGadgetWindow::LayoutSession ( )

virtual

LayoutSession is typically called when a change occurs in the size of the margins or gadgets, or when gadgets are added or deleted.

LayoutSession calls TileGadgets() to tile the gadgets in the specified direction and Invalidate() to mark the area as invalid (needs repainting).

Reimplemented in owl::TToolBox, and owl::TDockableGadgetWindow.

Definition at line 357 of file gadgetwi.cpp.

References owl::TWindow::GetHandle(), owl::TWindow::InvalidateRect(), and TileGadgets().

◆ LayoutUnitsToPixels()

int owl::TGadgetWindow::LayoutUnitsToPixels ( int units )

protected

Converts layout units to pixels.

A layout unit is determined by dividing the window font height by eight.

Definition at line 343 of file gadgetwi.cpp.

◆ Paint()

void owl::TGadgetWindow::Paint	(	TDC &	dc,
		bool	erase,
		TRect &	rect )

overrideprotectedvirtual

Puts the font into the device context and calls PaintGadgets.

Respond to virtual TWindow Paint call. Call our own virtual PaintGadgets to actually perform the painting of the gadgets

Reimplemented from owl::TWindow.

Definition at line 1364 of file gadgetwi.cpp.

References _T, owl::TTooltip::EnumTools(), owl::TTooltip::GetToolCount(), owl::TWindow::IsWindow(), owl::TDC::LineTo(), owl::TDC::MoveTo(), OWL_INI, PaintGadgets(), owl::TDC::RestorePen(), and owl::TDC::SelectObject().

◆ PaintGadgets()

void owl::TGadgetWindow::PaintGadgets	(	TDC &	dc,
		bool	erase,
		TRect &	rect )

protectedvirtual

Called by Paint to repaint all of the gadgets, PaintGadgets iterates through the list of gadgets, determines the gadget's area, and repaints each gadget.

You can override this function to implement a specific look (for example, separator line, raised, and so on).

Reimplemented in owl::TMessageBar.

Definition at line 1316 of file gadgetwi.cpp.

References owl::TDC::GetClipRgn(), owl::TDC::GetViewportOrg(), owl::TDC::IntersectClipRect(), owl::TDC::SelectClipRgn(), and owl::TDC::SetViewportOrg().

◆ PositionGadget()

void owl::TGadgetWindow::PositionGadget	(	TGadget *	previous,
		TGadget *	next,
		TPoint &	origin )

protectedvirtual

Virtual called by TileGadgets() for each gadget in order to give derived classes a chance to modify the gadget positioning.

Default is to overlap adjacent plain-bordered gadgets

Reimplemented in owl::TStatusBar.

Definition at line 597 of file gadgetwi.cpp.

References owl::TUIMetric::CxBorder, owl::TUIMetric::CyBorder, Horizontal, and owl::TGadget::Plain.

◆ PreProcessMsg()

bool owl::TGadgetWindow::PreProcessMsg ( MSG & msg )

overrideprotectedvirtual

Relays 'interesting' messages to the tooltip window.

Reimplemented from owl::TWindow.

Definition at line 1229 of file gadgetwi.cpp.

References owl::TWindow::IsChild(), owl::TWindow::IsWindow(), owl::TWindow::PreProcessMsg(), and owl::TTooltip::RelayEvent().

◆ Remove()

TGadget * owl::TGadgetWindow::Remove ( TGadget & gadget ) -> TGadget*

overridevirtual

Removes a gadget from the gadget window.

The gadget is returned but not destroyed. Remove returns 0 if the gadget is not in the window.

If this window has already been created, the calling application must call LayoutSession after any gadgets have been removed.

Reimplemented from owl::TGadgetList.

Definition at line 1086 of file gadgetwi.cpp.

References owl::TGadgetList::Remove().

◆ Removed()

void owl::TGadgetWindow::Removed ( TGadget & gadget )

overridevirtual

This indicates that a gadget has been removed from this gadget window.

Reimplemented from owl::TGadgetList.

Definition at line 1100 of file gadgetwi.cpp.

References GadgetReleaseCapture().

◆ SetCelArray()

void owl::TGadgetWindow::SetCelArray ( TCelArray * sharedCels )

virtual

Sets a new Shared CelArray for this gadget window.

Allows a predefined array of images to be shared by the gadgets. This GadgetWindow assumes ownership of the passed CelArray pointer.

Definition at line 1130 of file gadgetwi.cpp.

◆ SetDirection()

void owl::TGadgetWindow::SetDirection ( TTileDirection direction )

virtual

Sets the horizontal or vertical orientation of the gadgets.

If the gadget window is already created, SetDirection readjusts the dimensions of the gadget window to fit around the gadgets.

The setting of the direction parameter is also related to the setting of the second parameter (TLocation) in TDecoratedFrame's Insert function,. which specifies where the decoration is added in relation to the frame window's client window. If the second parameter in TDecoratedFrame::Insert() is set to top or bottom, the direction parameter in SetDirection must be horizontal. If the second parameter in TDecoratedFrame::Insert() is set to left or right, the direction parameter in SetDirection must be vertical.

Reimplemented in owl::TToolBox.

Definition at line 449 of file gadgetwi.cpp.

References owl::TMargins::Bottom, LayoutSession(), owl::TMargins::Left, owl::TMargins::Right, owl::TMargins::Top, and UseDesiredSize().

◆ SetHintCommand()

void owl::TGadgetWindow::SetHintCommand ( int id )

(id <= 0) to clear

Simulates menu selection messages so that ObjectWindows command processing can display command hints for the given command id (CM_xxxx).

Definition at line 299 of file gadgetwi.cpp.

References owl::TWindow::GetParentO(), owl::TWindow::HandleMessage(), and TYPESAFE_DOWNCAST.

◆ SetHintMode()

void owl::TGadgetWindow::SetHintMode ( THintMode hintMode )

inline

Sets the mode of the hint text.

Defaults to PressHints (displays hint text when a button is pressed).

Definition at line 445 of file gadgetwi.h.

◆ SetMargins()

void owl::TGadgetWindow::SetMargins ( const TMargins & margins )

Sets or changes the margins for the gadget window and calls LayoutSession().

Definition at line 332 of file gadgetwi.cpp.

References LayoutSession().

◆ SetRectangularDimensions()

void owl::TGadgetWindow::SetRectangularDimensions	(	int	width,
		int	height,
		int	rowMargin = -1 )

Sets the maximum width for each row used for rectangular layout.

LayoutSession() or SetDirection() must be called for changes to take effect

Definition at line 542 of file gadgetwi.cpp.

References Rectangular.

◆ SetShrinkWrap()

void owl::TGadgetWindow::SetShrinkWrap	(	bool	shrinkWrapWidth,
		bool	shrinkWrapHeight )

Sets the width and height of the data members.

By default, if the tile direction is horizontal, ShrinkWrapWidth is false and ShrinkWrapHeight is true. Also by default, if the direction is vertical, ShrinkWrapWidth is true and ShrinkWrapHeight is false.

Definition at line 250 of file gadgetwi.cpp.

◆ SetTooltip()

void owl::TGadgetWindow::SetTooltip ( TTooltip * tooltip )

Sets the Tooltip data member equal to tooltip.

If the tooltip is invalid (if Tooltip->GetHandle() fails), a new tooltip is created by the TTooltip::Create() function.

Definition at line 1567 of file gadgetwi.cpp.

References owl::TWindow::Create(), owl::TWindow::GetHandle(), owl::TWindow::ModifyStyle(), and owl::TWindow::SendMessage().

◆ SetupWindow()

void owl::TGadgetWindow::SetupWindow ( )

overrideprotectedvirtual

Overrides TWindow::SetupWindow to create tooltips for the gadget window.

JGD This fixes problem with tooltips and dialog initially showing JGD up behind the main window (BTS 43768)

Reimplemented from owl::TWindow.

Definition at line 1159 of file gadgetwi.cpp.

References EnableTimer(), GetDesiredSize(), LayoutSession(), owl::TWindow::PostMessage(), owl::TWindow::SetupWindow(), owl::TWindow::SetWindowPos(), WM_OWLCREATETTIP, owl::TSize::X(), and owl::TSize::Y().

◆ SetWantTooltip()

void owl::TGadgetWindow::SetWantTooltip ( bool wantTooltip )

inline

Definition at line 496 of file gadgetwi.h.

◆ TileGadgets()

TRect owl::TGadgetWindow::TileGadgets ( )

protectedvirtual

Tiles the Gadgets in the current direction.

Tiles the gadgets in the direction requested (horizontal or vertical).

Calls PositionGadget() to give derived classes an opportunity to adjust the spacing between gadgets in their windows.

Reimplemented in owl::TToolBox.

Definition at line 618 of file gadgetwi.cpp.

References LayoutGadgets().

◆ UseDesiredSize()

void owl::TGadgetWindow::UseDesiredSize ( )

protected

Updates the Size in Attr.W and Attr.H to match that obtained using GetDesiredSize() for each dimension that is shrink-wrapped.

Definition at line 411 of file gadgetwi.cpp.

References GetDesiredSize().

Friends And Related Symbol Documentation

◆ TGadget

friend class TGadget

friend

Definition at line 361 of file gadgetwi.h.

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

include/owl/gadgetwi.h
source/owlcore/gadgetwi.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TFlatStyle

◆ THintMode

◆ TTileDirection

Constructor & Destructor Documentation

◆ TGadgetWindow()

◆ ~TGadgetWindow()

Member Function Documentation

◆ CleanupWindow()

◆ Create()

◆ EnableFlatStyle()

◆ EnableThemeBackground()

◆ EnableTimer()

◆ EnableTooltip()

◆ EvCommand()

◆ EvCommandEnable()

◆ EvCreateTooltips()

◆ EvEraseBkgnd()

◆ EvLButtonDblClk()

◆ EvLButtonDown()

◆ EvLButtonUp()

◆ EvMouseMove()

◆ EvRButtonDown()

◆ EvRButtonUp()

◆ EvSysColorChange()

◆ EvWindowPosChanging()

◆ GadgetChangedSize()

◆ GadgetGetCaptured()

◆ GadgetReleaseCapture()

◆ GadgetSetCapture()

◆ GetCelArray()

◆ GetDesiredSize()

◆ GetDirection()

◆ GetFlatStyle()

◆ GetFont()

◆ GetFontHeight()

◆ GetHintMode()

◆ GetInnerRect()

◆ GetMargins() [1/3]

◆ GetMargins() [2/3]

◆ GetMargins() [3/3]

◆ GetTooltip()

◆ GetWantTooltip()

◆ IdleAction()

◆ Insert()

◆ Inserted()

◆ InsertFrom()

◆ IsBackgroundThemed()

◆ IsThemeBackgroundEnabled()

◆ IsThemed()

◆ LayoutGadgets()

◆ LayoutSession()

◆ LayoutUnitsToPixels()

◆ Paint()

◆ PaintGadgets()

◆ PositionGadget()

◆ PreProcessMsg()

◆ Remove()

◆ Removed()

◆ SetCelArray()

◆ SetDirection()

◆ SetHintCommand()

◆ SetHintMode()

◆ SetMargins()

◆ SetRectangularDimensions()

◆ SetShrinkWrap()

◆ SetTooltip()

◆ SetupWindow()

◆ SetWantTooltip()

◆ TileGadgets()

◆ UseDesiredSize()

Friends And Related Symbol Documentation