My Project
SallyAPI::GUI::CDropDown Class Reference

Drop down. More...

#include <DropDown.h>

Inheritance diagram for SallyAPI::GUI::CDropDown:
SallyAPI::GUI::CControl SallyAPI::GUI::CGUIBaseObject SallyAPI::Core::CBaseObject

List of all members.

Public Member Functions

 CDropDown (SallyAPI::GUI::CGUIBaseObject *parent, int x, int y, int width, int controlId=0)
 Constructor.
virtual ~CDropDown ()
 Destructor.
virtual void SetLocalised (bool localised)
 Sets a localised.
virtual bool IsLocalised ()
 Query if this object is localised.
void AddItem (SallyAPI::GUI::CDropDownItem &item)
 Adds an item.
bool SelectItemById (int id)
 Select item by identifier.
bool SelectItemByIdentifier (const std::string &identifier)
 Select item by identifier.
std::string GetSelectedIdentifier ()
 Gets the selected identifier.
void Clear ()
 Clears this object to its blank/initial state.
int GetListSize ()
 Gets the list size.
void SortByName ()
 Sorts the entries by name.
std::vector
< SallyAPI::GUI::CDropDownItem > & 
GetItemList ()
 Gets the item list.

Detailed Description

Drop down.

Author:
Christian Knobloch
Date:
19.04.2010

Constructor & Destructor Documentation

CDropDown::CDropDown ( SallyAPI::GUI::CGUIBaseObject parent,
int  x,
int  y,
int  width,
int  controlId = 0 
)

Constructor.

m_iImage(NULL), m_fDeltaStart(0), m_iImageSize(ICON_SIZE), m_bParentLocalised(true)

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
[in,out]parentIf non-null, the parent.
xThe x coordinate.
yThe y coordinate.
widthThe width.
controlIdIdentifier for the control.
CDropDown::~CDropDown ( ) [virtual]

Destructor.

Author:
Christian Knobloch
Date:
19.04.2010

Member Function Documentation

Adds an item.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
[in,out]itemThe item.
void CDropDown::Clear ( )

Clears this object to its blank/initial state.

Author:
Christian Knobloch
Date:
19.04.2010

Gets the item list.

Author:
Christian Knobloch
Date:
19.04.2010
Returns:
The item list.

Gets the list size.

Author:
Christian Knobloch
Date:
19.04.2010
Returns:
The list size.

Gets the selected identifier.

Author:
Christian Knobloch
Date:
19.04.2010
Returns:
The selected identifier.
bool CDropDown::IsLocalised ( ) [virtual]

Query if this object is localised.

Author:
Christian Knobloch
Date:
19.04.2010
Returns:
true if localised, false if not.

Reimplemented from SallyAPI::GUI::CControl.

bool CDropDown::SelectItemById ( int  id)

Select item by identifier.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
idThe identifier.
Returns:
true if it succeeds, false if it fails.
bool CDropDown::SelectItemByIdentifier ( const std::string &  identifier)

Select item by identifier.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
identifierThe identifier.
Returns:
true if it succeeds, false if it fails.
void CDropDown::SetLocalised ( bool  localised) [virtual]

Sets a localised.

Author:
Christian Knobloch
Date:
19.04.2010
Parameters:
localisedtrue to localised.

Reimplemented from SallyAPI::GUI::CControl.

Sorts the entries by name.

Author:
Christian Knobloch
Date:
19.12.2011

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines