Public Member Functions | Public Attributes

fl7::faces::DropDownBox Class Reference

#include <DropDownBox.h>

Inheritance diagram for fl7::faces::DropDownBox:
fl7::faces::Fusion fl7::faces::Collection fl7::faces::Face

List of all members.

Public Member Functions

 DropDownBox (Shell *const shell)
virtual ~DropDownBox (void)
const cl7::string_typeGetText () const
bool IsEditable () const
void SetText (const cl7::string_type &text)
void IsEditable (const bool editable)
bool IsItemSelected (int index) const
void SelectItem (int index)
void SelectNone ()
int GetSelectedIndex () const
void SetSelectedIndex (int index)
size_t GetItemCount () const
bool ContainsItem (const items::ListItem &item) const
int FindItem (const items::ListItem &item) const
const items::ListItemGetItem (int index) const
items::ListItemGetItem (int index)
void SetItem (int index, const items::ListItem &item)
void AddItem (const items::ListItem &item)
void InsertItem (const items::ListItem &item, int index)
void RemoveItem (int index)
void ClearItems ()

Public Attributes

events::EventHandler
< events::EventArgs
OnTextChangedEventHandler
events::EventHandler
< events::EventArgs
OnConfirmEventHandler
events::EventHandler
< events::ItemEventArgs
OnAddItemEventHandler
events::EventHandler
< events::ItemEventArgs
OnRemoveItemEventHandler
events::EventHandler
< events::ItemEventArgs
OnSetItemEventHandler
events::EventHandler
< events::ItemEventArgs
OnSelectItemEventHandler
events::EventHandler
< events::ItemEventArgs
OnDeselectItemEventHandler

Constructor & Destructor Documentation

fl7::faces::DropDownBox::DropDownBox ( Shell *const   shell  ) 

Explicit constructor.

fl7::faces::DropDownBox::~DropDownBox ( void   )  [virtual]

Destructor.


Member Function Documentation

void fl7::faces::DropDownBox::AddItem ( const items::ListItem item  ) 

Adds a given item to this drop down box.

void fl7::faces::DropDownBox::ClearItems (  ) 

Removes all items from this drop down box.

bool fl7::faces::DropDownBox::ContainsItem ( const items::ListItem item  )  const [inline]

Checks whether a given item is contained in this drop down box.

int fl7::faces::DropDownBox::FindItem ( const items::ListItem item  )  const [inline]

Finds a given item and returns its index in this drop down box. The function returns -1 if the given item was not found.

const items::ListItem& fl7::faces::DropDownBox::GetItem ( int  index  )  const [inline]

Returns the item at the given index in this drop down box.

items::ListItem& fl7::faces::DropDownBox::GetItem ( int  index  )  [inline]

Returns the item at the given index in this drop down box.

size_t fl7::faces::DropDownBox::GetItemCount (  )  const [inline]

Returns the number of items contained in this drop down box.

int fl7::faces::DropDownBox::GetSelectedIndex (  )  const [inline]

Returns the index of the currently selected item. If no item is selected, the function will return -1.

const cl7::string_type& fl7::faces::DropDownBox::GetText (  )  const [inline]

Returns the text of this drop down box. That is either the text of the currently selected item or (if the user may type in own text) the typed in or edited text.

void fl7::faces::DropDownBox::InsertItem ( const items::ListItem item,
int  index 
)

Adds a given item to this drop down box inserting it at the given index. If the index is negative or greater than the current number of item, the function will have no effect.

Adds a given item to this drop down box inserting it at the given index. If the index is negative or greater than the current number of items, the function will have no effect.

void fl7::faces::DropDownBox::IsEditable ( const bool  editable  ) 

Sets the flag specifying whether the user may type in own text.

bool fl7::faces::DropDownBox::IsEditable (  )  const [inline]

Returns the flag specifying whether the user may type in own text.

bool fl7::faces::DropDownBox::IsItemSelected ( int  index  )  const [inline]

Checks whether the item identified by the given index is selected.

void fl7::faces::DropDownBox::RemoveItem ( int  index  ) 

Removes the item at the given index from this drop down box.

void fl7::faces::DropDownBox::SelectItem ( int  index  ) 

Selects the item identified by the given index. If the given index is less than zero, no item will be selected. state.

void fl7::faces::DropDownBox::SelectNone (  ) 

Selects no item.

void fl7::faces::DropDownBox::SetItem ( int  index,
const items::ListItem item 
)

Updates the item at the given index in this drop down box. (If the given index is not valid the function has no effect).

void fl7::faces::DropDownBox::SetSelectedIndex ( int  index  )  [inline]

Sets the index of the currently selected item. If the given index is less than zero, no item will be selected.

void fl7::faces::DropDownBox::SetText ( const cl7::string_type text  ) 

Sets the text of this drop down box. That is either the text of the currently selected item or (if the user may type in own text) the typed in or edited text. If the user may not type in own text, this function has no effect.


Member Data Documentation

Will be called after the text of this drop down box has been confirmed.

Will be called after the text of this drop down box has been changed.


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