My Project
|
Drop down. More...
#include <DropDown.h>
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. |
Drop down.
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)
[in,out] | parent | If non-null, the parent. |
x | The x coordinate. | |
y | The y coordinate. | |
width | The width. | |
controlId | Identifier for the control. |
CDropDown::~CDropDown | ( | ) | [virtual] |
Destructor.
void CDropDown::AddItem | ( | SallyAPI::GUI::CDropDownItem & | item | ) |
Adds an item.
[in,out] | item | The item. |
void CDropDown::Clear | ( | ) |
Clears this object to its blank/initial state.
std::vector< SallyAPI::GUI::CDropDownItem > & CDropDown::GetItemList | ( | ) |
Gets the item list.
int CDropDown::GetListSize | ( | ) |
Gets the list size.
std::string CDropDown::GetSelectedIdentifier | ( | ) |
Gets the selected identifier.
bool CDropDown::IsLocalised | ( | ) | [virtual] |
Query if this object is localised.
Reimplemented from SallyAPI::GUI::CControl.
bool CDropDown::SelectItemById | ( | int | id | ) |
Select item by identifier.
id | The identifier. |
bool CDropDown::SelectItemByIdentifier | ( | const std::string & | identifier | ) |
Select item by identifier.
identifier | The identifier. |
void CDropDown::SetLocalised | ( | bool | localised | ) | [virtual] |
Sets a localised.
localised | true to localised. |
Reimplemented from SallyAPI::GUI::CControl.
void CDropDown::SortByName | ( | ) |
Sorts the entries by name.