W32DLib
W32DLib::Control Class Reference

The base Control class. More...

#include <w32dlib/control.h>

Inheritance diagram for W32DLib::Control:
W32DLib::Window W32DLib::AutoCheck W32DLib::Button W32DLib::ComboBox W32DLib::RadioButton W32DLib::StaticText W32DLib::Text

Public Member Functions

 Control (Dialog *parent, int resource_id, DataX *datax)
 Constructor.
 
virtual ~Control ()
 Destructor.
 
int ResourceID ()
 Returns the Resource ID for the control.
 
BOOL ProcessMessage (UINT msg, WPARAM wp, LPARAM lp)
 Processes a windows event.
 
virtual void DoDataExchange (bool set)
 Provides a base DoDataExchange.
 
- Public Member Functions inherited from W32DLib::Window
 Window ()
 Constructor.
 
virtual ~Window ()
 Destructor.
 
bool HasMutex ()
 Whether the Window() constructor could create a mutex.
 
HWND GetHWND ()
 Returns the HWND for the window.
 
HMENU GetHMENU ()
 Returns the HMENU associated with this window.
 
bool SetHMENU (HMENU menu)
 Sets the HMENU associated with this window.
 
bool Move (int x, int y, int width, int height, bool repaint=true)
 Sets a Window's position and size.
 
bool MoveBase (Window *w, int x, int y, int width, int height, bool repaint=true)
 Sets a Window's position and size using Dialog base units.
 
LRESULT SendMsg (UINT msg, WPARAM wp, LPARAM lp)
 Send a message to the window.
 
void SetText (const TCHAR *text)
 Sets the window text.
 
void SetText (const W32String &text)
 Sets the window text.
 
W32String GetText ()
 Gets the window text.
 
void Enable (bool enable)
 Enables or disables the window.
 

Protected Member Functions

void AddCallback (UINT msg, UINT notification, Window *owner, W32DLibCallback callback)
 Add a callback for the control.
 
- Protected Member Functions inherited from W32DLib::Window
virtual BOOL InstanceProc (HWND wnd, UINT msg, WPARAM wp, LPARAM lp)
 Handles windows messages.
 

Protected Attributes

Dialogm_parent
 Filled in by the constructor with the parent dialog.
 
int m_resid
 Filled in by the constructor with the resource ID.
 
DataXm_data
 Filled in by the constructor with the DataX object.
 
- Protected Attributes inherited from W32DLib::Window
HWND m_wnd
 The window handle for this window.
 

Additional Inherited Members

- Static Protected Member Functions inherited from W32DLib::Window
static BOOL CALLBACK WindowProc (HWND wnd, UINT msg, WPARAM wp, LPARAM lp)
 The base WindProc.
 

Detailed Description

The base Control class.

Constructor & Destructor Documentation

W32DLib::Control::Control ( Dialog parent,
int  resource_id,
DataX datax 
)

Constructor.

When a control is constructed it calls Dialog::AddControl to add itself to the dialog.

Parameters
parentThe Dialog the control belongs to.
resource_idThe ID of the control in the resource file.
dataxThe DataX to use. NULL means don't use data exchange.
virtual W32DLib::Control::~Control ( )
virtual

Destructor.

Member Function Documentation

void W32DLib::Control::AddCallback ( UINT  msg,
UINT  notification,
Window owner,
W32DLibCallback  callback 
)
protected

Add a callback for the control.

Note that multiple callbacks can be lodged for the same msg and notification. If this is the case then the result returned through ProcessMessage is the logical OR of all the returns.

When multiple callbacks match they are called in the order they were registered.

Parameters
msgThe Windows event message to respond to.
notificationThe top word of the WPARAM will be checked against this. If zero, then ignored.
ownerThe class (generally a Dialog derived one) in which the callback resides. The class must be derived from Window.
callbackThe callback.
virtual void W32DLib::Control::DoDataExchange ( bool  set)
virtual

Provides a base DoDataExchange.

This interface is called by the Dialog to say that data exchange should take place.

This base version simply honours DataX eString objects and calls Window::SetText or Window::GetText accordingly.

Parameters
setIf true the set the Control from the DataX object. If false then set the DataX object from the Control.

Reimplemented in W32DLib::ComboBox, W32DLib::AutoCheck, and W32DLib::RadioButton.

BOOL W32DLib::Control::ProcessMessage ( UINT  msg,
WPARAM  wp,
LPARAM  lp 
)

Processes a windows event.

This is called by the Dialog when a message is recieved that refers to this control's resource ID.

Parameters
msgThe Windows event
wpThe Windows event parameters
lpThe Windows event parameters
Returns
TRUE if the message was processed.
int W32DLib::Control::ResourceID ( )

Returns the Resource ID for the control.

Member Data Documentation

DataX* W32DLib::Control::m_data
protected

Filled in by the constructor with the DataX object.

Dialog* W32DLib::Control::m_parent
protected

Filled in by the constructor with the parent dialog.

int W32DLib::Control::m_resid
protected

Filled in by the constructor with the resource ID.


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