W32DLib
W32DLib::ComboBox Class Reference

The ComboBox class. More...

#include <w32dlib/combobox.h>

Inheritance diagram for W32DLib::ComboBox:
W32DLib::Control W32DLib::Window

Public Member Functions

 ComboBox (Dialog *parent, int resource_id, DataX *datax)
 Constructor.
 
virtual ~ComboBox ()
 Destructor.
 
void OnSelection (Window *owner, W32DLibCallback callback)
 Sets a callback for when selection changes.
 
void OnDoubleClick (Window *owner, W32DLibCallback callback)
 Sets a callback for when a list entry is double clicked.
 
void OnTextChanged (Window *owner, W32DLibCallback callback)
 Sets a callback for when the text is altered.
 
void Reset ()
 Resets the items in a combo box.
 
void MaxLen (int count)
 Sets the maximum length the user can enter.
 
int Count ()
 The number of strings in the combo box.
 
int AddString (const TCHAR *text)
 Adds a string to the combo box.
 
int AddString (const W32String &text)
 Adds a string to the combo box.
 
int AddString (const TCHAR *text, int index)
 Adds a string to the combo box.
 
int AddString (const W32String &text, int index)
 Adds a string to the combo box.
 
int RemoveString (int index)
 Removes a string from the combo box.
 
W32String GetString (int index)
 Gets a string from the combo box.
 
int TopRowIndex ()
 Gets the index of the item at the top of the list.
 
void TopRowIndex (int index)
 Sets the index of the item at the top of the list.
 
int SelectedIndex ()
 Gets the index of the current selection.
 
void SelectedIndex (int index)
 Sets the index of the current selection.
 
virtual void DoDataExchange (bool set)
 Performs data exchange.
 
- Public Member Functions inherited from W32DLib::Control
 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.
 
- 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.
 

Additional Inherited Members

- Protected Member Functions inherited from W32DLib::Control
void AddCallback (UINT msg, UINT notification, Window *owner, W32DLibCallback callback)
 Add a callback for the control.
 
- Static Protected Member Functions inherited from W32DLib::Window
static BOOL CALLBACK WindowProc (HWND wnd, UINT msg, WPARAM wp, LPARAM lp)
 The base WindProc.
 
- Protected Attributes inherited from W32DLib::Control
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.
 

Detailed Description

The ComboBox class.

Constructor & Destructor Documentation

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

Constructor.

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::ComboBox::~ComboBox ( )
virtual

Destructor.

Member Function Documentation

int W32DLib::ComboBox::AddString ( const TCHAR *  text)

Adds a string to the combo box.

Parameters
textThe string to add.
Returns
The index of the added string, or CB_ERR or CB_ERRSPACE.
int W32DLib::ComboBox::AddString ( const W32String text)

Adds a string to the combo box.

Parameters
textThe string to add.
Returns
The index of the added string, or CB_ERR or CB_ERRSPACE.
int W32DLib::ComboBox::AddString ( const TCHAR *  text,
int  index 
)

Adds a string to the combo box.

Parameters
textThe string to add.
indexThe index to insert in front of
Returns
The index of the added string, or CB_ERR or CB_ERRSPACE.
int W32DLib::ComboBox::AddString ( const W32String text,
int  index 
)

Adds a string to the combo box.

Parameters
textThe string to add.
indexThe index to insert in front of
Returns
The index of the added string, or CB_ERR or CB_ERRSPACE.
int W32DLib::ComboBox::Count ( )

The number of strings in the combo box.

Returns
The count or CB_ERR.
virtual void W32DLib::ComboBox::DoDataExchange ( bool  set)
virtual

Performs data exchange.

Support types:

eString – see Control::DoDataExchange()

eInt – same as SelectedIndex()

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

Reimplemented from W32DLib::Control.

W32String W32DLib::ComboBox::GetString ( int  index)

Gets a string from the combo box.

Parameters
indexThe index of the string to retrieve.
Returns
The string.
void W32DLib::ComboBox::MaxLen ( int  count)

Sets the maximum length the user can enter.

Parameters
countThe maximum number of characters the user can enter.
void W32DLib::ComboBox::OnDoubleClick ( Window owner,
W32DLibCallback  callback 
)

Sets a callback for when a list entry is double clicked.

Note this only works of the list has a CBS_SIMPLE style.

Parameters
ownerThe class the callback reside in.
callbackThe callback.
void W32DLib::ComboBox::OnSelection ( Window owner,
W32DLibCallback  callback 
)

Sets a callback for when selection changes.

Parameters
ownerThe class the callback resides in.
callbackThe callback.
void W32DLib::ComboBox::OnTextChanged ( Window owner,
W32DLibCallback  callback 
)

Sets a callback for when the text is altered.

Note this will not work if the list has a CBS_DROPDOWNLIST style.

Parameters
ownerThe class the callback reside in.
callbackThe callback.
int W32DLib::ComboBox::RemoveString ( int  index)

Removes a string from the combo box.

Parameters
indexThe index of the string to remove.
Returns
The count of remaining items, or CB_ERR.
void W32DLib::ComboBox::Reset ( )

Resets the items in a combo box.

int W32DLib::ComboBox::SelectedIndex ( )

Gets the index of the current selection.

Returns
The index, or CB_ERR.
void W32DLib::ComboBox::SelectedIndex ( int  index)

Sets the index of the current selection.

Parameters
indexThe index.
int W32DLib::ComboBox::TopRowIndex ( )

Gets the index of the item at the top of the list.

Returns
The index, or CB_ERR.
void W32DLib::ComboBox::TopRowIndex ( int  index)

Sets the index of the item at the top of the list.

Parameters
indexThe index.

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