Photon microGUI widgets library 0.6.0
PhWidgets::ComboBox Struct Reference

A text field with a list of choices. More...

#include <ComboBox.h>

Inheritance diagram for PhWidgets::ComboBox:
PhWidgets::Compound PhWidgets::Container PhWidgets::Basic PhWidgets::Widget

Classes

struct  Arguments
 Contains resource IDs for all ComboBox arguments. More...
 
struct  ArgUnsignedLong
 Contains resource IDs for arguments of type unsigned long. More...
 
struct  ArgUnsignedShort
 Contains resource IDs for arguments of type unsigned short. More...
 
struct  Callback
 Contains resource IDs for callbacks of type PtCallback_t. More...
 
struct  Callbacks
 Contains resource IDs for all ComboBox callbacks. More...
 
struct  Flags
 Contains flags for all ComboBox resources. More...
 
struct  ThisArgs
 Contains resource IDs for ComboBox arguments. More...
 
struct  ThisCallbacks
 Contains resource IDs for ComboBox callbacks. More...
 
struct  ThisFlags
 Contains flags for ComboBox resources. More...
 

Public Member Functions

 ComboBox (int abn)
 (constructor) More...
 
 ComboBox (PtWidget_t *wdg)
 (constructor) More...
 
 ComboBox (const ComboBox &other)
 (copy constructor) More...
 
ComboBoxoperator= (const ComboBox &other)
 Assigns value in ComboBox widget. More...
 
void AddItem (std::string item, unsigned int pos=0)
 Adds an item to the drop-down list of items. More...
 
void Clear ()
 Deletes all of the items from the drop-down list. More...
 
void RemoveItem (std::string item)
 Remove specific item from a list. More...
 
void RemoveItemAt (unsigned int pos)
 Remove specific item from a list at specified position. More...
 
void ReplaceItem (std::string item, unsigned int pos)
 Replaces an item in the drop-down list of items. More...
 
- Public Member Functions inherited from PhWidgets::Compound
 Compound (int abn)
 (constructor) More...
 
 Compound (PtWidget_t *wdg)
 (constructor) More...
 
- Public Member Functions inherited from PhWidgets::Container
 Container (int abn)
 (constructor) More...
 
 Container (PtWidget_t *wdg)
 (constructor) More...
 
 Container (const Container &other)
 (copy constructor) More...
 
Containeroperator= (const Container &other)
 Assigns value in Container widget. More...
 
- Public Member Functions inherited from PhWidgets::Basic
 Basic (int abn)
 (constructor) More...
 
 Basic (PtWidget_t *wdg)
 (constructor) More...
 
 Basic (const Basic &other)
 (copy constructor) More...
 
Basicoperator= (const Basic &other)
 Assigns value in Basic widget. More...
 
void OnActivated (PtCallbackInfo_t *info)
 Raises the Basic::Activate event.
 
void OnArmed (PtCallbackInfo_t *info)
 Raises the Basic::Arm event.
 
void OnDisarmed (PtCallbackInfo_t *info)
 Raises the Basic::Disarm event.
 
void OnGotFocused (PtCallbackInfo_t *info)
 Raises the Basic::GotFocus event.
 
void OnLostFocus (PtCallbackInfo_t *info)
 Raises the Basic::LostFocus event.
 
void OnMenu (PtCallbackInfo_t *info)
 Raises the Basic::Menu event.
 
void OnRepeat (PtCallbackInfo_t *info)
 Raises the Basic::Repeat event.
 
- Public Member Functions inherited from PhWidgets::Widget
 Widget (int abn)
 (constructor) More...
 
 Widget (PtWidget_t *wdg)
 (constructor) More...
 
 Widget (const Widget &other)
 (copy constructor) More...
 
void swap (Widget &other)
 Exchanges the contents of *this and other. More...
 
Widgetoperator= (const Widget &other)
 Assigns value in Widget. More...
 
Widgetoperator= (PtWidget_t *wdg)
 Assigns value in Widget. More...
 
bool operator== (const Widget &other) const
 Compares Widgets. More...
 
bool operator!= (const Widget &other) const
 Compares Widgets. More...
 
bool operator< (const Widget &other) const
 Compares Widgets. More...
 
bool operator<= (const Widget &other) const
 Compares Widgets. More...
 
bool operator> (const Widget &other) const
 Compares Widgets. More...
 
bool operator>= (const Widget &other) const
 Compares Widgets. More...
 
PtWidget_tget () const
 Returns the stored pointer.
 
 operator PtWidget_t * ()
 Converts Widget to Photon widget pointer.
 
 operator const PtWidget_t * () const
 Converts Widget to constant Photon widget pointer.
 
void BringToFront ()
 Brings the widget to the front of the z-order. More...
 
bool Contains (const Widget &widget)
 Retrieves a value indicating whether the specified widget is a child of the widget. More...
 
bool Focus ()
 Sets input focus to the widget. More...
 
Widget GetNextWidget (const Widget &widget, bool forward=true) const
 Retrieves the next widget forward or back in the tab order of child widgets. More...
 
void Hide ()
 Conceals the widget from the user. More...
 
void Invalidate (PhRect_t rc, bool invalidateChildren=false)
 Invalidates a specific region of the widget and causes a paint message to be sent to the widget. More...
 
void Invalidate (bool invalidateChildren=false)
 Invalidates a specific region of the widget and causes a paint message to be sent to the widget. More...
 
bool Realize ()
 Make the widget and its children visible and possibly interactive. More...
 
void Refresh ()
 Forces the widget to invalidate its client area and immediately redraw itself and any child widgets. More...
 
void SendToBack ()
 Sends the widget to the back of the z-order. More...
 
void SetBounds (short x, short y, unsigned short width, unsigned short height)
 Sets the bounds of the widget to the specified location and size. More...
 
void SetBounds (short x, short y)
 Sets the bounds of the widget to the specified location. More...
 
void Select ()
 Activates the widget. More...
 
void Show ()
 Displays the widget to the user. More...
 
bool Unrealize ()
 Unrealizes the widget and all its children. More...
 
void OnDestroyed (PtCallbackInfo_t *info)
 Raises the Widget::Destroyed event.
 
void OnBlocked (PtCallbackInfo_t *info)
 Raises the Widget::Blocked event.
 
void OnDragDrop (PtCallbackInfo_t *info)
 Raises the Widget::DragDrop event.
 
void OnOutbound (PtCallbackInfo_t *info)
 Raises the Widget::Outbound event.
 
void OnRealized (PtCallbackInfo_t *info)
 Raises the Widget::Realized event.
 
void OnUnrealized (PtCallbackInfo_t *info)
 Raises the Widget::Unrealized event.
 

Public Attributes

WidgetResourcesSingleton resource
 Resources of the ComboBox. More...
 
Properties

Properties are used to simplify use of widget resources.

property< PhWidgets::ComboBoxStyle::eComboBoxStyle >::bind< ComboBox, &ComboBox::getDropDownStyle, &ComboBox::setDropDownStyle > DropDownStyle
 Gets or sets a value specifying the style of the combo box. More...
 
property< bool >::bind< ComboBox, &ComboBox::getDroppedDown, &ComboBox::setDroppedDown > DroppedDown
 Gets or sets a value indicating whether the combo box is displaying its drop-down portion. More...
 
- Public Attributes inherited from PhWidgets::Container
WidgetResourcesSingleton resource
 Resources of the Container. More...
 
property< Widget >::bind< Container, &Container::getActiveWidget, &Container::setActiveWidget > ActiveWidget
 Gets or sets the active widget on the Container widget. More...
 
phwidgets_event< Container, Container::Callbacks::child_added_removed > ChildAddedRemoved
 
phwidgets_event< Container, Container::Callbacks::child_getting_focus > ChildGettingFocus
 
phwidgets_event< Container, Container::Callbacks::child_losing_focus > ChildLosingFocus
 
phwidgets_event< Container, Container::Callbacks::layout > LayoutChanged
 
phwidgets_event< Container, Container::Callbacks::resize > Resize
 
- Public Attributes inherited from PhWidgets::Basic
WidgetResourcesSingleton resource
 Resources of the Basic. More...
 
phproperty< Drawing::Color >::bind< Basic, Arguments< PgColor_t >::ColorResource, Arguments<>::BevelColor > BevelColor
 Gets or sets the main color of the bevel. More...
 
phproperty< Drawing::Color >::bind< Basic, Arguments< PgColor_t >::ColorResource, Arguments<>::DrawingColor > Color
 Gets or sets the foreground or drawing color for the widget. More...
 
phproperty< Drawing::Color >::bind< Basic, Arguments< PgColor_t >::ColorResource, Arguments<>::DarkBevelColor > DarkBevelColor
 Gets or sets the dark outermost color used when applying a bevel to a widget. More...
 
phproperty< Drawing::Color >::bind< Basic, Arguments< PgColor_t >::ColorResource, Arguments<>::DarkFillColor > DarkFillColor
 Gets or sets the dark color with which a gradient (if applied) goes. More...
 
phproperty< Drawing::Color >::bind< Basic, Arguments< PgColor_t >::ColorResource, Arguments<>::FillColor > FillColor
 Gets or sets the fill color for the widget. More...
 
phproperty< Drawing::Color >::bind< Basic, Arguments< PgColor_t >::ColorResource, Arguments<>::InlineColor > InlineColor
 Gets or sets the color of the inline of the border. More...
 
phproperty< Drawing::Color >::bind< Basic, Arguments< PgColor_t >::ColorResource, Arguments<>::LightBevelColor > LightBevelColor
 Gets or sets the light outermost color used when applying a bevel to a widget. More...
 
phproperty< Drawing::Color >::bind< Basic, Arguments< PgColor_t >::ColorResource, Arguments<>::LightFillColor > LightFillColor
 Gets or sets the light color with which a gradient (if applied) goes. More...
 
phproperty< unsigned short >::bind< Basic, Arguments< unsigned short >::Scalar, Arguments<>::MarginHeight > MarginHeight
 Gets or sets the amount of vertical space between the widget's canvas and the widget's border. More...
 
phproperty< unsigned short >::bind< Basic, Arguments< unsigned short >::Scalar, Arguments<>::MarginWidth > MarginWidth
 Gets or sets the amount of horizontal space between the widget's canvas and the widget's border. More...
 
phproperty< Drawing::Color >::bind< Basic, Arguments< PgColor_t >::ColorResource, Arguments<>::OutlineColor > OutlineColor
 Gets or sets the color of the outline of the border. More...
 
phbitmask< unsigned long, Flags::Basic::type >::bind< Basic, Arguments< unsigned long >::Scalar, Arguments<>::BasicFlags > BasicFlags
 Gets or sets basic flags inherited by all widgets. See Flags::Basic::type.
 
phwidgets_event< Basic, Basic::Callbacks<>::Activate > Activate
 Occurs when you release the left pointer button while pointing at an armed widget.
 
phwidgets_event< Basic, Basic::Callbacks<>::Arm > Arm
 Occurs when you press the left pointer button while pointing at the widget.
 
phwidgets_event< Basic, Basic::Callbacks<>::Disarm > Disarm
 Occurs when you release the left pointer button when not pointing at an armed widget.
 
phwidgets_event< Basic, Basic::Callbacks<>::GotFocus > GotFocus
 Occurs when a widget gets focus or its focus status changes.
 
phwidgets_event< Basic, Basic::Callbacks<>::LostFocus > LostFocus
 Occurs when a widget loses focus.
 
phwidgets_event< Basic, Basic::Callbacks<>::Menu > Menu
 Occurs when you press the right button while the pointer is on top of the widget.
 
phwidgets_event< Basic, Basic::Callbacks<>::Repeat > Repeat
 Documentation in progress...
 
- Public Attributes inherited from PhWidgets::Widget
WidgetResourcesSingleton resource
 Resources of the Widget. More...
 
property< bool >::bind< Widget, &Widget::getAllowDrop, &Widget::setAllowDrop > AllowDrop
 Gets or sets a value indicating whether the widget can accept data that the user drags onto it. More...
 
phbitmask< unsigned, Flags::Anchor::type, Flags::Anchor::All >::bind< Widget, Arguments< unsigned >::Flag, Arguments< unsigned >::AnchorFlags > Anchor
 Gets or sets flags specifying how the widget is anchored to its parent. More...
 
phproperty< unsigned short >::bind< Widget, Arguments< unsigned short >::Scalar, Arguments< unsigned short >::BevelWidth > BevelWidth
 Gets or sets the bevel width of the widget. More...
 
property< short, property<>::ro >::bind< Widget, &Widget::getBottom > Bottom
 Gets the distance, in pixels, between the bottom edge of the widget and the top edge of its container's client area. More...
 
property< PhArea_t >::bind< Widget, &Widget::getBounds, &Widget::setBounds > Bounds
 Gets or sets the size and location of the widget including its nonclient elements, in pixels, relative to the parent widget. More...
 
property< bool, property<>::ro >::bind< Widget, &Widget::getCanFocus > CanFocus
 Gets a value indicating whether the widget can receive focus. More...
 
property< bool, property<>::ro >::bind< Widget, &Widget::getCanSelect > CanSelect
 Gets a value indicating whether the widget can be selected. More...
 
property< bool, property<>::ro >::bind< Widget, &Widget::getContainsFocus > ContainsFocus
 Gets a value indicating whether the widget, or one of its child widgets, currently has the input focus. More...
 
property< PhWidgets::Cursor >::bind< Widget, &Widget::getCursor, &Widget::setCursor > Cursor
 Gets or sets the cursor that is displayed when the mouse pointer is over the widget. More...
 
phproperty< Drawing::Color >::bind< Widget, Arguments< PgColor_t >::Color, Arguments< PgColor_t >::CursorColor > CursorColor
 Gets or sets the color of the cursor pointer when it's inside the widget. More...
 
property< bool >::bind< Widget, &Widget::getEnabled, &Widget::setEnabled > Enabled
 Gets or sets a value indicating whether the widget can respond to user interaction. More...
 
property< bool, property<>::ro >::bind< Widget, &Widget::getFocused > Focused
 Gets a value indicating whether the widget has input focus. More...
 
property< bool, property<>::ro >::bind< Widget, &Widget::hasChildren > HasChildren
 Gets a value indicating whether the widget contains one or more child widgets. More...
 
property< bool, property<>::ro >::bind< Widget, &Widget::hasParent > HasParent
 Gets a value indicating whether the widget has parent. More...
 
phproperty< unsigned short >::bind< Widget, Arguments< unsigned short >::Scalar, Arguments< unsigned short >::Height > Height
 Gets or sets the height of the widget. More...
 
property< std::string >::bind< Widget, &Widget::getHelpTopic, &Widget::setHelpTopic > HelpTopic
 Gets or sets the help topic of the widget. More...
 
property< bool, property<>::ro >::bind< Widget, &Widget::getIsRealized > IsRealized
 Gets or sets a value indicating whether the widget is realized. More...
 
property< short >::bind< Widget, &Widget::getLeft, &Widget::setLeft > Left
 Gets or sets the distance, in pixels, between the left edge of the widget and the left edge of its container's client area. More...
 
property< PhPoint_t >::bind< Widget, &Widget::getLocation, &Widget::setLocation > Location
 Gets or sets the coordinates of the upper-left corner of the widget relative to the upper-left corner of its container. More...
 
property< PtWidget_t * >::bind< Widget, &Widget::getParent, &Widget::setParent > Parent
 Gets or sets the parent container of the widget. More...
 
phproperty< PhPoint_t >::bind< Widget, Arguments< PhPoint_t >::Struct, Arguments< PhPoint_t >::Position > Position
 Gets or sets the absolute coordinates of the upper-left corner of the widget. More...
 
property< short, property<>::ro >::bind< Widget, &Widget::getRight > Right
 Gets the distance, in pixels, between the right edge of the widget and the left edge of its container's client area. More...
 
phproperty< PhDim_t >::bind< Widget, Arguments< PhDim_t >::Struct, Arguments< PhDim_t >::Dimension > Size
 Gets or sets the size of the widget. More...
 
tag_property< Widget, &Widget::getTag, &Widget::setTag > Tag
 Gets or sets the resource that contains data about the widget. More...
 
property< short >::bind< Widget, &Widget::getTop, &Widget::setTop > Top
 Gets or sets the distance, in pixels, between the top edge of the widget and the top edge of its container's client area. More...
 
property< bool >::bind< Widget, &Widget::getVisible, &Widget::setVisible > Visible
 Gets or sets a value indicating whether the widget and all its child widgets are displayed. More...
 
property< std::set< PhWidgets::Widget >, property<>::ro >::bind< Widget, &Widget::getWidgets > Widgets
 Gets the list of widgets contained within the widget. More...
 
phproperty< unsigned short >::bind< Widget, Arguments< unsigned short >::Scalar, Arguments< unsigned short >::Width > Width
 Gets or sets the width of the widget. More...
 
phbitmask< unsigned long, Flags::Extended::type >::bind< Widget, Arguments< unsigned long >::Flag, Arguments< unsigned long >::ExtendedFlags > ExtendedFlags
 Gets or sets extended flags inherited by all widgets. See Flags::Extended::type.
 
phbitmask< long, Flags::type >::bind< Widget, Arguments< long >::Flag, Arguments< long >::Flags > WidgetFlags
 Gets or sets flags inherited by all widgets. More...
 
phbitmask< long, Flags::Resize::type >::bind< Widget, Arguments< long >::Flag, Arguments< long >::Resiztype > Resiztype
 Gets or sets flags to control a widget's resize policy. See Flags::Resize::type.

 
phwidgets_event< Widget, Widget::Callbacks<>::Destroyed > Destroyed
 Occurs when the widget is destroyed.
 
phwidgets_event< Widget, Widget::Callbacks<>::Blocked > Blocked
 Occurs when the widget is blocked.
 
phwidgets_event< Widget, Widget::Callbacks<>::DragAndDrop > DragDrop
 Occurs when a drag-and-drop operation is completed.
 
phwidgets_event< Widget, Widget::Callbacks<>::IsDestroyed > IsDestroyed
 Occurs when the widget's resources are being released.
 
phwidgets_event< Widget, Widget::Callbacks<>::Outbound > Outbound
 Occurs when you press the pointer button on the widget and then move out of the "hot spot" with the button still depressed.
 
phwidgets_event< Widget, Widget::Callbacks<>::Realized > Realized
 Occurs when the widget is realized.
 
phwidgets_event< Widget, Widget::Callbacks<>::Unrealized > Unrealized
 Occurs when the widget is unrealized.
 

Additional Inherited Members

- Public Types inherited from PhWidgets::Widget
typedef phevent::ph_callback_t callback_t
 An event handler that is raised when an event occur.
 
- Static Public Member Functions inherited from PhWidgets::Widget
static void Update ()
 Causes the Photon microGUI to redraw the all invalidated regions. More...
 

Detailed Description

A text field with a list of choices.

The ComboBox class provides a widget that's built from two exported subordinate widgets: List and Text.

A ComboBox widget provides a text-entry area and a list of choices.

You can type in the text field or choose a predefined entry from the list. The list can be either:
  • Static: Always present above or below the text field.
  • Dropping: You must click a button to see the list.
The widget behaves like a List or Text widget, depending on which part has focus.
Note
You can't specify the selection mode for the list.

To select an item using the pointer, either click on an item or drag the pointer down the list and release the button when the correct item is highlighted. You can select only one item. If you drag the pointer, the list can scroll.

A blocking mechanism lets ComboBox block the inheritance of certain resources from its subordinate widgets. This prevents any actions that would negatively affect the look and behavior of a ComboBox widget.

Constructor & Destructor Documentation

◆ ComboBox() [1/3]

PhWidgets::ComboBox::ComboBox ( int  abn)
explicit

(constructor)

Constructs a ComboBox widget by ID.

Parameters
[in]abnID given by PhAB to widget (like 'ABN_WIDGET_NAME').

◆ ComboBox() [2/3]

PhWidgets::ComboBox::ComboBox ( PtWidget_t wdg)
explicit

(constructor)

Constructs a ComboBox widget by pointer to widget.

Parameters
[in]wdgpointer to Photon widget.

◆ ComboBox() [3/3]

PhWidgets::ComboBox::ComboBox ( const ComboBox other)

(copy constructor)

Constructs a ComboBox widget by copy.

Parameters
[in]otheranother ComboBox widget to be used as source to initialize the elements of the container with.

Member Function Documentation

◆ AddItem()

void PhWidgets::ComboBox::AddItem ( std::string  item,
unsigned int  pos = 0 
)

Adds an item to the drop-down list of items.

Parameters
[in]itemThe string to add to the drop-down list.
[in]posThe position of item in the drop-down list.

Call AddItem(std::string item) to add a string to the end of drop-down list.

Remarks
List positions start at 1, not 0. If you specify a position of 0, the items are added to the end of the list. If you add new items in between existing items, the rest of the items are moved down the list.

◆ Clear()

void PhWidgets::ComboBox::Clear ( )

Deletes all of the items from the drop-down list.

Empties the drop-down list so that it contains no items.

◆ operator=()

ComboBox & PhWidgets::ComboBox::operator= ( const ComboBox other)

Assigns value in ComboBox widget.

Replaces the contents of the ComboBox widget.

Parameters
[in]otheranother ComboBox widget to use as data source.

◆ RemoveItem()

void PhWidgets::ComboBox::RemoveItem ( std::string  item)

Remove specific item from a list.

Parameters
[in]itemThe string to remove from the drop-down list.
Remarks
If there is more than one item with the same text then all items will be removed.

◆ RemoveItemAt()

void PhWidgets::ComboBox::RemoveItemAt ( unsigned int  pos)

Remove specific item from a list at specified position.

Parameters
[in]posThe position of item in the drop-down list.
Remarks
List positions start at 1, not 0.

◆ ReplaceItem()

void PhWidgets::ComboBox::ReplaceItem ( std::string  item,
unsigned int  pos 
)

Replaces an item in the drop-down list of items.

Parameters
[in]itemThe string to replace in the drop-down list.
[in]posThe position of item in the drop-down list.
Remarks
List positions start at 1, not 0.

Member Data Documentation

◆ DropDownStyle

property<PhWidgets::ComboBoxStyle::eComboBoxStyle>:: bind<ComboBox, &ComboBox::getDropDownStyle, &ComboBox::setDropDownStyle> PhWidgets::ComboBox::DropDownStyle

Gets or sets a value specifying the style of the combo box.

Property Value

ComboBoxStyle::eComboBoxStyle

Possible values are:

◆ DroppedDown

property<bool>:: bind<ComboBox, &ComboBox::getDroppedDown, &ComboBox::setDroppedDown> PhWidgets::ComboBox::DroppedDown

Gets or sets a value indicating whether the combo box is displaying its drop-down portion.

Property Value

bool

true if the drop-down portion is displayed; otherwise, false. The default is false.

◆ resource

WidgetResourcesSingleton PhWidgets::ComboBox::resource

Resources of the ComboBox.

See also

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