DigitalSpaces::DICEGUIComboDropList Struct Reference
[CEGUI]
#include <CEGUIInterfaces.h>
Inherits DigitalSpaces::DIObjectBase.
|
Public Member Functions |
| void | setArmed (bool setting) |
| | Set whether the drop-list is 'armed' for selection.
|
| bool | isArmed () |
| | Return the 'armed' state of the ComboDropList.
|
| void | setAutoArmEnabled (bool setting) |
| | Set the mode of operation for the ComboDropList.
|
| bool | isAutoArmEnabled () |
| | returns the mode of operation for the drop-list
|
Member Function Documentation
| void DigitalSpaces::DICEGUIComboDropList::setArmed |
( |
bool |
setting |
) |
|
Set whether the drop-list is 'armed' for selection.
- Note:
- This setting is not exclusively under client control; the ComboDropList will auto-arm in response to certain left mouse button events. This is also dependant upon the autoArm setting of the ComboDropList.
- Parameters:
-
| setting |
- true to arm the box; items will be highlighted and the next left button up event will cause dismissal and possible item selection.
|
- false to disarm the box; items will not be highlighted or selected until the box is armed.
- Returns:
- Nothing.
| bool DigitalSpaces::DICEGUIComboDropList::isArmed |
( |
|
) |
|
Return the 'armed' state of the ComboDropList.
- Returns:
- true if the box is armed; items will be highlighted and the next left button up event will cause dismissal and possible item selection.
- false if the box is not armed; items will not be highlighted or selected until the box is armed.
| void DigitalSpaces::DICEGUIComboDropList::setAutoArmEnabled |
( |
bool |
setting |
) |
|
Set the mode of operation for the ComboDropList.
- Parameters:
-
| setting |
- true if the ComboDropList auto-arms when the mouse enters the box.
- false if the user must click to arm the box.
|
- Returns:
- Nothing.
| bool DigitalSpaces::DICEGUIComboDropList::isAutoArmEnabled |
( |
|
) |
|
returns the mode of operation for the drop-list
- Returns:
- true if the ComboDropList auto-arms when the mouse enters the box.
- false if the user must click to arm the box.
The documentation for this struct was generated from the following file:
