A gadget for displaying a time and/or date message. More...

#include <owl/timegadg.h>

Inheritance diagram for owl::TTimeGadget:

Public Types
typedef void(*	TGetTimeFunc) (tstring &)
	Function prototype of callback invoked to retrieve the correct time.

Public Types inherited from owl::TTextGadget
enum	TAlign { Left , Center , Right }
	Enumerates the text-alignment attributes. More...

Public Types inherited from owl::TGadget
enum	TBorderStyle { None , Plain , Raised , Recessed , Embossed , Grooved , ButtonUp , ButtonDn , WndRaised , WndRecessed , WellSet }
	Gadget border styles. More...

Public Member Functions
	TTimeGadget (TGetTimeFunc timeFunc=&TTimeGadget::GetSystemTime, int id=0, TBorderStyle=Recessed, TAlign=Center, uint numChars=12, LPCTSTR text=0, TFont *font=0)
	Constructor for TTimeGadget.

	TTimeGadget (TGetTimeFunc timeFunc, int id, TBorderStyle, TAlign, uint numChars, const tstring &text, TFont *font=0)
	String-aware overload.

void	Created ()
	Overriden from TGadget to inform gadget window to setup a timer.

bool	IdleAction (long count)
	Overridden from TGadget to display the current time.

Public Member Functions inherited from owl::TTextGadget
	TTextGadget (int id=0, TBorderStyle=Recessed, TAlign=Left, uint numChars=10, LPCTSTR text=0, TFont *font=0)
	Constructs a TTextGadget object with the specified ID, border style, and alignment.

	TTextGadget (int id, TBorderStyle, TAlign, uint numChars, const tstring &text, TFont *font=0)
	String-aware overload.

	~TTextGadget ()
	Destruct this text gadget and delete the text it is holding.

const TFont &	GetFont () const
	Returns the effective font used to render the text for this gadget.

void	SetFont (const TFont &, bool repaint=true)
	Sets the font to be used by the gadget.

LPCTSTR	GetText () const
	Returns the text for the gadget.

void	SetText (LPCTSTR text)
	Set the text for this gadget.

void	SetText (const tstring &text)

TColor	GetBkgndColor () const
	Returns the background color for the gadget.

TColor	GetTextColor () const
	Returns the text color for the gadget.

void	SetBkgndColor (const TColor &color)
	Sets the background color for the gadget.

void	SetTextColor (const TColor &color)
	Sets the text color for the gadget when enabled.

void	ResetBkgndColor ()
	Resets the background color of the gadget to the default TColor::Sys3dFace.

void	ResetTextColor ()
	Resets the text color of the gadget to the default TColor::SysBtnText.

Public Member Functions inherited from owl::TGadget
	TGadget (int id=0, TBorderStyle borderStyle=None)
	Construct a gadget with a given id and border style.

virtual	~TGadget ()
	Destroys a TGadget interface object and removes it from its associated window.

int	GetId () const
	Gets the ID for the gadget.

TRect &	GetBounds ()
	Returns the boundary rectangle for the gadget.

const TRect &	GetBounds () const
	Returns the boundary rectangle for the gadget.

virtual void	SetEnabled (bool enabled)
	Enables or disables keyboard and mouse input for the gadget.

bool	GetEnabled () const
	Determines whether keyboard and mouse input have been enabled for the specified gadget.

virtual void	SetVisible (bool visible)
	Changes the visibility of the gadget.

bool	IsVisible () const
	Returns true if the gadget is visible.

bool	IsWindowVisible () const
	check to see if the button's created

void	SetEndOfRow (bool eor)
	Sets the end of row property for the gadget.

bool	IsEndOfRow () const
	Returns true if this gadget is at the end of a row.

bool	IsWideAsPossible () const
	Indicates whether the gadget width will be adjusted by the gadget window to be as wide as possible in the remaining space.

void	SetWideAsPossible (bool wide=true)
	Sets the flag that indicates whether the gadget width will be adjusted by the gadget window to be as wide as possible in the remaining space.

void	SetShrinkWrap (bool shrinkWrapWidth, bool shrinkWrapHeight)
	Simple set accessor to set whether shrinkwrapping is performed horizontally and/or vertically.

void	SetSize (const TSize &size)
	Alters the size of the gadget and then calls TGadgetWindow::GadgetChangedSize() for the size change to take effect.

void	GetOuterSizes (int &left, int &right, int &top, int &bottom)
	Get the four total outer sizes in pixels which consists of the margins plus the borders.

void	GetInnerRect (TRect &rect)
	Computes the area of the gadget's rectangle excluding the borders and margins.

virtual void	SetBounds (const TRect &rect)
	Called by the gadget window to inform the gadget of a change in its bounding rectangle.

virtual void	CommandEnable ()
	Provided so that the gadget can perform command enabling (so it can handle an incoming message if it's appropriate to do so).

virtual void	SysColorChange ()
	Called when the system colors have been changed so that gadgets can rebuild and repaint, if necessary.

TGadget *	NextGadget ()
	Returns the next gadget in the list of gadgets.

void	SetBorders (const TBorders &borders)
	Sets the borders for the gadget.

TBorders &	GetBorders ()
	Gets the gadget's borders measured in border units that are based on SM_CXBORDER and SM_CYBORDER.

void	SetMargins (const TMargins &margins)
	Sets the margins of the gadget.

TMargins &	GetMargins ()
	Gets the margin dimensions.

void	SetBorderStyle (TBorderStyle bs)
	Set the border style used by this gadget.

TBorderStyle	GetBorderStyle () const
	Gets the style for the gadget's borders.

Static Public Member Functions
static void	GetTTime (tstring &)
	Retrieves the current time.

static void	GetSystemTime (tstring &)
	Retrieves the system time using the Win32 API.

static void	GetLocalTime (tstring &)
	Retrieves the local time using the Win32 API.

Additional Inherited Members
Protected Member Functions inherited from owl::TTextGadget
void	Paint (TDC &dc)
	Paint the text gadget by painting gadget borders, & then painting text in the InnerRect.

virtual TColor	GetEnabledColor () const

void	GetDesiredSize (TSize &size)
	Respond to the virtual call to let this gadget's Window know how big this text gadget wants to be based on the text size.

void	Invalidate ()
	Invalidate the working portion of this gadget–in this case just the InnerRect.

Protected Member Functions inherited from owl::TGadget
TGadgetWindow *	GetGadgetWindow ()
	Return a pointer to the owning or parent window for the gadget.

const TGadgetWindow *	GetGadgetWindow () const
	Return a pointer to the owning or parent window for the gadget.

virtual void	Inserted ()
	Called after a gadget is inserted into a window.

virtual void	Moved ()
	This is the virtual called when a gadget is relocated.

virtual void	Removed ()
	Virtual called after a gadget is removed from a window.

bool	IsHaveMouse () const
	Return true if mouse inside gadget.

void	SetInMouse (bool state)
	Sets if mouse inside gadget or not.

bool	GetTrackMouse () const

void	SetTrackMouse (bool track)

void	Invalidate (bool erase=true)
	Used to invalidate the active (usually nonborder) portion of the gadget, Invalidate calls InvalidateRect and passes the boundary width and height of the area to erase.

void	InvalidateRect (const TRect &rect, bool erase=true)
	Invalidate a rectangle in our containing window.

void	Update ()
	Paint now if possible.

virtual bool	PtIn (const TPoint &point)
	Default behavior returns true if the point is within the receiver's bounding rect.

virtual void	PaintBorder (TDC &dc)
	Self sent by method Paint().

virtual void	MouseEnter (uint modKeys, const TPoint &point)
	Mouse is entering this gadget.

virtual void	MouseMove (uint modKeys, const TPoint &point)
	Mouse is moving over this gadget.

virtual void	MouseLeave (uint modKeys, const TPoint &point)
	Mouse is leaving this gadget.

virtual void	LButtonDown (uint modKeys, const TPoint &point)
	Captures the mouse if TrackMouse is set.

virtual void	RButtonDown (uint modKeys, const TPoint &point)

virtual void	LButtonUp (uint modKeys, const TPoint &point)
	Releases the mouse capture if TrackMouse is set.

virtual void	RButtonUp (uint modKeys, const TPoint &point)

void	ChangeBorderStyle (TBorderStyle bs)
	Simply changes the border style without recalculating the gadget size.

Detailed Description

A gadget for displaying a time and/or date message.

Definition at line 30 of file timegadg.h.

Member Typedef Documentation

◆ TGetTimeFunc

typedef void(* owl::TTimeGadget::TGetTimeFunc) (tstring &)

Function prototype of callback invoked to retrieve the correct time.

Definition at line 34 of file timegadg.h.

Constructor & Destructor Documentation

◆ TTimeGadget() [1/2]

owl::TTimeGadget::TTimeGadget	(	TGetTimeFunc	timeFunc = &TTimeGadget::GetSystemTime,
		int	id = 0,
		TBorderStyle	border = Recessed,
		TAlign	align = Center,
		uint	numChars = 12,
		LPCTSTR	text = 0,
		TFont *	font = 0 )

Constructor for TTimeGadget.

Definition at line 20 of file timegadg.cpp.

References owl::TGadget::SetShrinkWrap().

◆ TTimeGadget() [2/2]

owl::TTimeGadget::TTimeGadget	(	TGetTimeFunc	timeFunc,
		int	id,
		TBorderStyle	border,
		TAlign	align,
		uint	numChars,
		const tstring &	text,
		TFont *	font = 0 )

String-aware overload.

Definition at line 33 of file timegadg.cpp.

References owl::TGadget::SetShrinkWrap().

Member Function Documentation

◆ Created()

void owl::TTimeGadget::Created ( )

virtual

Overriden from TGadget to inform gadget window to setup a timer.

Reimplemented from owl::TGadget.

Definition at line 52 of file timegadg.cpp.

References owl::TGadget::Created(), owl::TGadgetWindow::EnableTimer(), and owl::TGadget::GetGadgetWindow().

◆ GetLocalTime()

void owl::TTimeGadget::GetLocalTime ( tstring & newTime )

static

Retrieves the local time using the Win32 API.

Definition at line 115 of file timegadg.cpp.

References _T, and GetLocalTime().

◆ GetSystemTime()

void owl::TTimeGadget::GetSystemTime ( tstring & newTime )

static

Retrieves the system time using the Win32 API.

Definition at line 94 of file timegadg.cpp.

References _T, and GetSystemTime().

◆ GetTTime()

void owl::TTimeGadget::GetTTime ( tstring & newTime )

static

Retrieves the current time.

Definition at line 80 of file timegadg.cpp.

◆ IdleAction()

bool owl::TTimeGadget::IdleAction ( long count )

virtual

Overridden from TGadget to display the current time.

Reimplemented from owl::TGadget.

Definition at line 62 of file timegadg.cpp.

References owl::TGadget::IdleAction(), and owl::TTextGadget::SetText().

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

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

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TGetTimeFunc

Constructor & Destructor Documentation

◆ TTimeGadget() [1/2]

◆ TTimeGadget() [2/2]

Member Function Documentation

◆ Created()

◆ GetLocalTime()

◆ GetSystemTime()

◆ GetTTime()

◆ IdleAction()