lecui 1.0.0-alpha.20
lecui C++ user interface library
|
Combobox widget. To instantiate and add to a container use the add static method. More...
#include <combobox.h>
Classes | |
struct | combobox_events |
Events specific to this widget. More... | |
struct | combobox_item |
A combobox item. More... | |
Public Member Functions | |
combobox () | |
Constructor. | |
combobox_events & | events () |
Get or set combobox events. More... | |
bool | operator== (const combobox ¶m) |
Check whether widget specs are equal. Only those properties that require the widget resources to be re-created are considered. More... | |
bool | operator!= (const combobox ¶m) |
Check whether widget specs are NOT equal. Only those properties that require the widget resources to be re-created are considered. More... | |
std::string & | text () override |
Get or set the widget text. More... | |
combobox & | text (const std::string &text) |
Set the widget's text. More... | |
std::string & | tooltip () override |
Get or set the widget's tooltip text. More... | |
combobox & | tooltip (const std::string &tooltip) |
Set the tooltip text. More... | |
lecui::rect & | rect () override |
Get or set the position and dimensions of the widget. More... | |
combobox & | rect (const lecui::rect &rect) |
Set the position and dimensions of the widget. More... | |
resize_params & | on_resize () override |
Get or set the behaviour of the widget when its container is resized. More... | |
combobox & | on_resize (const resize_params &on_resize) |
Set the behaviour of the widget when its container is resized. More... | |
cursor_type & | cursor () override |
Get or set the mouse cursor to use then over the widget. More... | |
combobox & | cursor (const cursor_type cursor) |
Set the mouse cursor to use when over the widget. More... | |
std::string & | font () override |
Get or set the default widget font, e.g. "Georgia". More... | |
combobox & | font (const std::string &font) |
Set the default widget font. More... | |
float & | font_size () override |
Get or set the default widget font size in points, e.g. 9.0f. More... | |
combobox & | font_size (const float &font_size) |
Set the widget's font size. More... | |
color & | color_text () override |
Get or set the color of the widget's text. More... | |
combobox & | color_text (const color &color_text) |
Set the color of the widget's text. More... | |
color & | color_fill () override |
Get or set the fill color of the widget. More... | |
combobox & | color_fill (const color &color_fill) |
Set the fill color of the widget. More... | |
color & | color_hot () override |
Get or set the widget's color when the mouse is hovered over it. More... | |
combobox & | color_hot (const color &color_hot) |
Set the widget's color when the mouse is hovered over it. More... | |
color & | color_selected () override |
Get or set the widget's color when selected. More... | |
combobox & | color_selected (const color &color_selected) |
Set the widget's color when selected. More... | |
color & | color_disabled () override |
Get or set the widget's color when it is disabled. More... | |
combobox & | color_disabled (const color &color_disabled) |
Set the widget's color when it is disabled. More... | |
float & | border () |
Get or set the thickness of the border. More... | |
combobox & | border (const float &border) |
Set the thickness of the border. More... | |
color & | color_border () |
Get or set the color of the border. More... | |
combobox & | color_border (const color &color_border) |
Set the color of the border. More... | |
float & | corner_radius_x () |
Get or set the horizontal radius of the corners. More... | |
combobox & | corner_radius_x (const float &corner_radius_x) |
Set the horizontal radius of the corners. More... | |
float & | corner_radius_y () |
Get or set the vertical radius of the corners. More... | |
combobox & | corner_radius_y (const float &corner_radius_y) |
Set the vertical radius of the corners. More... | |
bool & | editable () |
Get or set the combobox editable property. More... | |
combobox & | editable (const bool &editable) |
Set the combobox editable property. More... | |
color & | color_fill_editable () |
Get or set the fill color of an editable combobox. More... | |
combobox & | color_fill_editable (const color &color_fill_editable) |
Set the fill color of an editable combobox. More... | |
color & | color_caret () |
Get or set the color of the caret. More... | |
combobox & | color_caret (const color &color_caret) |
Set the color of the caret. More... | |
color & | color_dropdown () |
Get or set the color of the dropdown. More... | |
combobox & | color_dropdown (const color &color_dropdown) |
Set the color of the dropdown. More... | |
color & | color_dropdown_hot () |
Get or set the color of the dropdown when the mouse is hovered over it. More... | |
combobox & | color_dropdown_hot (const color &color_dropdown_hot) |
Set the color of the dropdown when the mouse is hovered over it. More... | |
color & | color_dropdown_arrow () |
Get or set the color of the dropdown arrow. More... | |
combobox & | color_dropdown_arrow (const color &color_dropdown_arrow) |
Set the color of the dropdown arrow. More... | |
color & | color_dropdown_arrow_hot () |
Get or set the color of the dropdown arrow when the mouse is hovered over it. More... | |
combobox & | color_dropdown_arrow_hot (const color &color_dropdown_arrow_hot) |
Set the color of the dropdown arrow when the mouse is hovered over it. More... | |
std::vector< combobox_item > & | items () |
Get or set the list of combobox items. More... | |
combobox & | items (const std::vector< combobox_item > &items) |
Set the list of combobox items. More... | |
image_quality & | quality () |
Get or set the quality of the images. More... | |
combobox & | quality (const image_quality &quality) |
Set the quality of the images. More... | |
sort_options & | sort () |
Get or set the sort options. More... | |
combobox & | sort (const sort_options &sort) |
Set the sort options. More... | |
bool & | force_numerical_sort () |
Get or set whether numerical sorting is forced. More... | |
combobox & | force_numerical_sort (const bool &force_numerical_sort) |
Set whether numerical sorting is forced. More... | |
std::string & | selected () |
Get or set the selected item. More... | |
combobox & | selected (const std::string &selected) |
Set the selected item. More... | |
![]() | |
widget () | |
Widget constructor. | |
virtual | ~widget () |
Widget descructor. | |
bool | operator== (const widget ¶m) |
Check whether widget's basic specifications are equal. Only those properties that require the widget's basic resources to be re-created are considered. More... | |
bool | operator!= (const widget ¶m) |
Check whether widget's basic specifications are NOT equal. Only those properties that require the widget's basic resources to be re-created are considered. More... | |
virtual std::string & | text ()=0 |
Get or set the widget text. More... | |
virtual std::string & | tooltip ()=0 |
Get or set the widget's tooltip text. More... | |
virtual lecui::rect & | rect ()=0 |
Get or set the position and dimensions of the widget. More... | |
virtual resize_params & | on_resize ()=0 |
Get or set the behaviour of the widget when its container is resized. More... | |
virtual cursor_type & | cursor ()=0 |
Get or set the mouse cursor to use then over the widget. More... | |
virtual std::string & | font ()=0 |
Get or set the default widget font, e.g. "Georgia". More... | |
virtual float & | font_size ()=0 |
Get or set the default widget font size in points, e.g. 9.0f. More... | |
virtual color & | color_text ()=0 |
Get or set the color of the widget's text. More... | |
virtual color & | color_fill ()=0 |
Get or set the fill color of the widget. More... | |
virtual color & | color_hot ()=0 |
Get or set the widget's color when the mouse is hovered over it. More... | |
virtual color & | color_selected ()=0 |
Get or set the widget's color when selected. More... | |
virtual color & | color_disabled ()=0 |
Get or set the widget's color when it's disabled. More... | |
basic_events & | events () |
Widget events. More... | |
const std::string & | alias () |
The widget's alias, either user defined or automatically generated by the library. More... | |
Static Public Member Functions | |
static combobox & | add (containers::page &page, const std::string &alias=std::string()) |
Add a combobox to a container. More... | |
static combobox & | get (form &fm, const std::string &path) |
Get the specifications of a combobox. More... | |
Additional Inherited Members | |
![]() | |
enum class | cursor_type { arrow , hand , caret } |
Mouse cursor type. More... | |
![]() | |
std::string | _text |
The widget's text. | |
std::string | _tooltip |
The widget's tooltip text. | |
lecui::rect | _rect |
The widget's rectangle. | |
resize_params | _on_resize = { 0.f, 0.f, 0.f, 0.f } |
The widget's behaviour when container is resized. | |
cursor_type | _cursor = cursor_type::arrow |
The widget's cursor. | |
std::string | _font = "Segoe UI" |
The widget's font. | |
float | _font_size = 9.f |
The widget's font size. | |
color | _color_text = { 0, 0, 0, 255 } |
The color of the widget's text. | |
color | _color_fill = { 0, 120, 170, 255 } |
The fill color of the widget. | |
color | _color_hot = { 0, 120, 170, 255 } |
The color to indicate when the mouse hovers over the widget. | |
color | _color_selected = { 0, 120, 170, 30 } |
The color to indicate when the widget is selected. | |
color | _color_disabled = { 180, 180, 180, 255 } |
The color to indicate when the widget is disabled. | |
Combobox widget. To instantiate and add to a container use the add static method.
Recommended height with defaults is 25px
|
static |
Add a combobox to a container.
page | The container to place the widget in. |
alias | The in-page unique alias, e.g. "title". |
If an empty alias is given an internally generated random alias will be assigned.
float & liblec::lecui::widgets::combobox::border | ( | ) |
Get or set the thickness of the border.
combobox & liblec::lecui::widgets::combobox::border | ( | const float & | border | ) |
Set the thickness of the border.
border | The border thickness, in pixels. |
color & liblec::lecui::widgets::combobox::color_border | ( | ) |
Get or set the color of the border.
Set the color of the border.
color_border | The border color, as defined in color. |
color & liblec::lecui::widgets::combobox::color_caret | ( | ) |
Get or set the color of the caret.
Set the color of the caret.
color_caret | The color of the caret. |
|
overridevirtual |
Get or set the widget's color when it is disabled.
Implements liblec::lecui::widgets::widget.
Set the widget's color when it is disabled.
color_disabled | The color of the widget when it is disabled, as defined in color. |
color & liblec::lecui::widgets::combobox::color_dropdown | ( | ) |
Get or set the color of the dropdown.
Set the color of the dropdown.
color_dropdown | The color of the dropdown. |
color & liblec::lecui::widgets::combobox::color_dropdown_arrow | ( | ) |
Get or set the color of the dropdown arrow.
combobox & liblec::lecui::widgets::combobox::color_dropdown_arrow | ( | const color & | color_dropdown_arrow | ) |
Set the color of the dropdown arrow.
color_dropdown_arrow | The color. |
color & liblec::lecui::widgets::combobox::color_dropdown_arrow_hot | ( | ) |
Get or set the color of the dropdown arrow when the mouse is hovered over it.
combobox & liblec::lecui::widgets::combobox::color_dropdown_arrow_hot | ( | const color & | color_dropdown_arrow_hot | ) |
Set the color of the dropdown arrow when the mouse is hovered over it.
color_dropdown_arrow_hot | The color. |
color & liblec::lecui::widgets::combobox::color_dropdown_hot | ( | ) |
Get or set the color of the dropdown when the mouse is hovered over it.
Set the color of the dropdown when the mouse is hovered over it.
color_dropdown_hot | The color. |
|
overridevirtual |
Get or set the fill color of the widget.
Implements liblec::lecui::widgets::widget.
Set the fill color of the widget.
color_fill | The fill color. |
color & liblec::lecui::widgets::combobox::color_fill_editable | ( | ) |
Get or set the fill color of an editable combobox.
combobox & liblec::lecui::widgets::combobox::color_fill_editable | ( | const color & | color_fill_editable | ) |
Set the fill color of an editable combobox.
|
overridevirtual |
Get or set the widget's color when the mouse is hovered over it.
Implements liblec::lecui::widgets::widget.
Set the widget's color when the mouse is hovered over it.
color_hot | The color. |
|
overridevirtual |
Get or set the widget's color when selected.
Implements liblec::lecui::widgets::widget.
Set the widget's color when selected.
color_selected | The widget's color when selected. |
|
overridevirtual |
Get or set the color of the widget's text.
Implements liblec::lecui::widgets::widget.
Set the color of the widget's text.
color_text | The color of the widget's text. |
float & liblec::lecui::widgets::combobox::corner_radius_x | ( | ) |
Get or set the horizontal radius of the corners.
combobox & liblec::lecui::widgets::combobox::corner_radius_x | ( | const float & | corner_radius_x | ) |
Set the horizontal radius of the corners.
corner_radius_x | The horizontal radius of the corner, in pixels. |
float & liblec::lecui::widgets::combobox::corner_radius_y | ( | ) |
Get or set the vertical radius of the corners.
combobox & liblec::lecui::widgets::combobox::corner_radius_y | ( | const float & | corner_radius_y | ) |
Set the vertical radius of the corners.
corner_radius_y | The horizontal radius of the corner, in pixels. |
|
overridevirtual |
Get or set the mouse cursor to use then over the widget.
Implements liblec::lecui::widgets::widget.
combobox & liblec::lecui::widgets::combobox::cursor | ( | const cursor_type | cursor | ) |
Set the mouse cursor to use when over the widget.
cursor | The cursor type as defined in cursor_type. |
bool & liblec::lecui::widgets::combobox::editable | ( | ) |
Get or set the combobox editable property.
combobox & liblec::lecui::widgets::combobox::editable | ( | const bool & | editable | ) |
Set the combobox editable property.
editable | Whether to make the combobox editable. |
|
inline |
Get or set combobox events.
|
overridevirtual |
Get or set the default widget font, e.g. "Georgia".
Implements liblec::lecui::widgets::widget.
combobox & liblec::lecui::widgets::combobox::font | ( | const std::string & | font | ) |
Set the default widget font.
font | The font's name, e.g. "Georgia". |
|
overridevirtual |
Get or set the default widget font size in points, e.g. 9.0f.
Implements liblec::lecui::widgets::widget.
combobox & liblec::lecui::widgets::combobox::font_size | ( | const float & | font_size | ) |
Set the widget's font size.
font_size | The font size in points, e.g. 9.0f. |
bool & liblec::lecui::widgets::combobox::force_numerical_sort | ( | ) |
Get or set whether numerical sorting is forced.
When only numbers are in the items list numerical sorting is used. The presence of at least one non-numeric character causes string sorting to be used instead. In those instances where you need numerical sorting to be used regardless of the presence of non-numeric characters this is the way to do it.
combobox & liblec::lecui::widgets::combobox::force_numerical_sort | ( | const bool & | force_numerical_sort | ) |
Set whether numerical sorting is forced.
force_numerical_sort | Whether to force numerical sorting. |
When only numbers are in the items list numerical sorting is used. The presence of at least one non-numeric character causes string sorting to be used instead. In those instances where you need numerical sorting to be used regardless of the presence of non-numeric characters this is the way to do it.
|
static |
Get the specifications of a combobox.
fm | A reference to the form. |
path | The full path to the widget, e.g. "sample_page/sample_tab_pane/tab_one/title". |
Throws on failure. For faster coding and more readable code consider calling this static method through the helper macro provided.
std::vector< combobox_item > & liblec::lecui::widgets::combobox::items | ( | ) |
Get or set the list of combobox items.
combobox & liblec::lecui::widgets::combobox::items | ( | const std::vector< combobox_item > & | items | ) |
Set the list of combobox items.
items | The list. |
|
overridevirtual |
Get or set the behaviour of the widget when its container is resized.
Implements liblec::lecui::widgets::widget.
combobox & liblec::lecui::widgets::combobox::on_resize | ( | const resize_params & | on_resize | ) |
Set the behaviour of the widget when its container is resized.
on_resize | The resize parameters as defined in resize_params. |
bool liblec::lecui::widgets::combobox::operator!= | ( | const combobox & | param | ) |
Check whether widget specs are NOT equal. Only those properties that require the widget resources to be re-created are considered.
param | The specs to compare to. |
bool liblec::lecui::widgets::combobox::operator== | ( | const combobox & | param | ) |
Check whether widget specs are equal. Only those properties that require the widget resources to be re-created are considered.
param | The specs to compare to. |
image_quality & liblec::lecui::widgets::combobox::quality | ( | ) |
Get or set the quality of the images.
combobox & liblec::lecui::widgets::combobox::quality | ( | const image_quality & | quality | ) |
Set the quality of the images.
quality | The quality, as defined in quality. |
|
overridevirtual |
Get or set the position and dimensions of the widget.
The position is in reference to the widget's container.
Implements liblec::lecui::widgets::widget.
combobox & liblec::lecui::widgets::combobox::rect | ( | const lecui::rect & | rect | ) |
Set the position and dimensions of the widget.
rect | The widget's rectangle. |
std::string & liblec::lecui::widgets::combobox::selected | ( | ) |
Get or set the selected item.
Note that this is not always the same as the .text variable in an editable combobox. The .text in an editable combobox only becomes part of the list of items when the user presses the enter key. Only then can it be considered as a "selected" item.
combobox & liblec::lecui::widgets::combobox::selected | ( | const std::string & | selected | ) |
Set the selected item.
selected | The selected item. |
|
inline |
Get or set the sort options.
combobox & liblec::lecui::widgets::combobox::sort | ( | const sort_options & | sort | ) |
Set the sort options.
sort | The sort options, as defined in sort_options. |
|
overridevirtual |
Get or set the widget text.
Implements liblec::lecui::widgets::widget.
combobox & liblec::lecui::widgets::combobox::text | ( | const std::string & | text | ) |
Set the widget's text.
text | The text. |
|
overridevirtual |
Get or set the widget's tooltip text.
Implements liblec::lecui::widgets::widget.
combobox & liblec::lecui::widgets::combobox::tooltip | ( | const std::string & | tooltip | ) |
Set the tooltip text.
tooltip | The tooltip text. |