lecui 1.0.0-alpha.20
lecui C++ user interface library
Namespaces | Classes | Typedefs | Enumerations | Functions
liblec::lecui Namespace Reference

Namespace for the lecui library. More...

Namespaces

namespace  containers
 Namespace for lecui containers.
 

Classes

class  appearance
 Manipulate the form's appearance. More...
 
class  color
 RGBA color on a standard 0 to 255 scale. For the alpha channel 0 is transparent and 255 is opaque. More...
 
class  color_picker
 Color picker. More...
 
class  context_menu
 Context menu. More...
 
class  controls
 Manipulate a form's controls. More...
 
struct  date
 Date class. More...
 
class  date_time
 Interact with date/time. More...
 
class  defaults
 lecui defaults class. More...
 
class  dimensions
 Manipulate a form's dimensions. More...
 
struct  file_type
 File type. More...
 
class  filesystem
 Interact with the OS file system. More...
 
class  form
 Form base class. The user must inherit from this class and call one of the two constructors from its own constructor. More...
 
class  form_menu
 Form menu. More...
 
struct  form_menu_item
 Menu items. More...
 
class  get
 Helper class for extracting values from a std::any. Strictly added to enable more terse code and make the code more readable. More...
 
class  instance_manager
 Manage application instances. More...
 
struct  menu_item
 Menu items. More...
 
class  open_file_params
 Open file parameters. More...
 
class  page_manager
 Page manager class. More...
 
class  point
 A point. More...
 
class  rect
 Rectangle class. More...
 
class  resize_params
 Resize parameters. More...
 
class  save_file_params
 Save file parameters. More...
 
class  size
 Size of a rectangular structure. More...
 
class  splash
 Splash screen class. Useful for displaying graphics while app is loading. More...
 
struct  table_column
 Table column. More...
 
class  time
 Time class. More...
 
class  timer_manager
 Timer manager class. More...
 
class  tray_icon
 Tray icon class. More...
 
struct  tray_menu_item
 Menu items. More...
 
class  widget_manager
 Widget manager class. More...
 

Typedefs

using table_row = std::map< std::string, std::any >
 Table row; a list of (column, value) pairs. The map's "key" is the column name and it's "value" is the value under that column for the given row, e.g. { { "Name", "John" }, { "Surname", "Doe" }, { "Height", 172 } }
 

Enumerations

enum class  themes { light , dark }
 Themes that are implemented within the library. More...
 
enum class  element {
  form , titlebar , accent , accent_hover ,
  disabled , scrollbar , scrollbar_border , scrollbar_hover ,
  scrollbar_pressed , label , label_selected , label_hover ,
  label_pressed , label_disabled , button , button_border ,
  button_hover , button_selected , checkbox , checkbox_border ,
  checkbox_tick , checkbox_hover , checkbox_selected , progress_bar ,
  progress_bar_border , progress_bar_unfilled , progress_indicator , progress_indicator_text ,
  progress_indicator_unfilled , text_field , text_field_border , text_field_disabled ,
  text_field_prompt , text_field_selected , text_field_caret , text_field_input_error ,
  table_view , table_view_border , table_view_alternate , table_view_row_hover ,
  table_view_row_selected , table_view_text_header , table_view_text_header_hot , table_view_text_selected ,
  table_view_header , table_view_grid , toggle , toggle_on ,
  toggle_off , toggle_selected , tree_view , tree_view_border ,
  tree_view_hover , tree_view_selected , tab_pane , tab_pane_border ,
  tab_pane_tabs , tab_pane_selected_tab , pane , pane_border ,
  image_view , image_view_border , image_view_hover , image_view_selected ,
  rectangle , rectangle_border , rectangle_border_hot , rectangle_hover ,
  rectangle_selected , group , group_border , slider ,
  slider_border , slider_knob , slider_knob_hot , slider_knob_border ,
  slider_tick , slider_selected , html_editor , html_editor_border ,
  html_editor_disabled , html_editor_selected , html_editor_caret , html_control ,
  html_control_border , combobox , combobox_editable , combobox_caret ,
  combobox_border , combobox_hover , combobox_selected , combobox_dropdown ,
  combobox_dropdown_hot , combobox_dropdown_arrow , combobox_dropdown_arrow_hot , line ,
  line_hover , line_selected , icon , icon_border ,
  icon_hot , icon_text , icon_description_text , strength_bar ,
  strength_bar_border , badge , badge_border , badge_text
}
 The element to color. More...
 
enum class  form_position {
  center_to_working_area , center_to_parent , top_left , top_left_offset ,
  bottom_left , bottom_left_offset , top_right , top_right_offset ,
  bottom_right , bottom_right_offset
}
 Form position. More...
 
enum class  sort_options { ascending , descending , none }
 Sort options. More...
 
enum class  image_quality { low , medium , high }
 Image render quality. Used when resampling images. More...
 
enum class  text_alignment { left , center , right , justified }
 Text alignment. More...
 
enum class  paragraph_alignment { top , middle , bottom }
 Paragraph alignment. More...
 

Functions

std::string lecui_api version ()
 Get the version of the lecui library. More...
 
std::string lecui_api unique_string ()
 Make a unique string. More...
 
std::string lecui_api unique_string_short ()
 Make a short unique string. More...
 

Detailed Description

Namespace for the lecui library.

Enumeration Type Documentation

◆ element

enum class liblec::lecui::element
strong

The element to color.

All hover colors apply to non-static widgets. Refer to widget documentation for more information.

Enumerator
form 

The background color of the form.

titlebar 

The fill color of the form's title bar.

accent 

The accent color.

accent_hover 

The accent color on hover.

disabled 

The color of disabled controls.

scrollbar 

The fill color of scrollbars.

scrollbar_border 

The color of scrollbar borders.

scrollbar_hover 

The fill color of scrollbars when the mouse hovers over them.

scrollbar_pressed 

The fill color of scrollbars when they are pressed.

label 

The color of labels (text color).

label_selected 

The background color of selected labels.

label_hover 

The background color of labels when the mouse hovers over them.

label_pressed 

The background color of labels when they are pressed.

label_disabled 

The color of disabled labels (text color).

button 

The fill color of buttons.

button_border 

The color of button borders.

button_hover 

The color of buttons when the mouse hovers over them.

button_selected 

The border color of selected buttons.

checkbox 

The fill color of checkboxes.

checkbox_border 

The color of checkbox borders.

checkbox_tick 

The color of checkbox ticks.

checkbox_hover 

The fill color of checkboxes when the mouse hovers over them.

checkbox_selected 

The border color of selected checkboxes.

progress_bar 

The color of the filled portion progress bars.

progress_bar_border 

The color of progress bar borders.

progress_bar_unfilled 

The color of the un-filled portion of the progress bar.

progress_indicator 

The line color of the filled portion of progress indicators (including the dot).

progress_indicator_text 

The color of progress indicator text.

progress_indicator_unfilled 

The line color of the un-filled portion of progress indicators.

text_field 

The fill color of text fields.

text_field_border 

The color of text field borders.

text_field_disabled 

The color of a disabled text field.

text_field_prompt 

The color of prompt text in a text field.

text_field_selected 

The border color of a selected text field.

text_field_caret 

The color of a text field caret.

text_field_input_error 

The border color of a text field when an invalid input is detected.

table_view 

The background color of table view odd rows.

table_view_border 

The color of a table view borders.

table_view_alternate 

The alternate color of table view even rows.

table_view_row_hover 

The color of a row when the mouse hovers over it.

table_view_row_selected 

The background color of a selected table view row.

table_view_text_header 

The color of table view header text.

table_view_text_header_hot 

The color of table view header text when the mouse is hovered over it.

table_view_text_selected 

The border color of a selected table view.

table_view_header 

The background color of table view headers.

table_view_grid 

The line color of table view grids.

toggle 

The color of the toggle circle.

toggle_on 

The background color of toggles when they're on.

toggle_off 

The background color of toggles when they're off.

toggle_selected 

The background color of toggle labels when the toggle is selected.

tree_view 

The background color of tree views.

tree_view_border 

The color of tree view borders.

tree_view_hover 

The background color of tree view labels when the mouse is hovered over them.

tree_view_selected 

The border color of a selected tree view.

tab_pane 

The background color of tab panes.

tab_pane_border 

The border color of tab panes.

tab_pane_tabs 

The background color of tabs.

tab_pane_selected_tab 

The color of the bar that indicates the selected tab.

pane 

The background color of panes.

pane_border 

The border color of panes.

image_view 

The background color of image views.

image_view_border 

The border color of image views.

image_view_hover 

The border color of image views when the mouse is hovered over them.

image_view_selected 

The border color of a selected image view.

rectangle 

The background color of rectangles.

rectangle_border 

The border color of rectangles.

rectangle_border_hot 

The border color of rectangles when the mouse is hovered over them.

rectangle_hover 

The background color of rectangles when the mouse is hovered over them.

rectangle_selected 

The border color of a selected rectangle.

group 

The background color of groups.

group_border 

The border color of groups.

slider 

The background color of a slider.

slider_border 

The border color of a slider.

slider_knob 

The color of a slider's knob.

slider_knob_hot 

The color of a slider's knob when the mouse is hovered over it.

slider_knob_border 

The border color of a slider's knob.

slider_tick 

The color of a slider's tick lines.

slider_selected 

The border color of a slider's knob when the slider is selected.

html_editor 

The background color of html editors.

html_editor_border 

The border color of html editors.

html_editor_disabled 

The background color of disabled html editors.

html_editor_selected 

The border color of a selected html editor.

html_editor_caret 

The color of the caret in the html editor.

html_control 

The background color of the html editor control pane.

html_control_border 

The border color of the html editor control pane.

combobox 

The background color of non-editable comboboxes.

combobox_editable 

The background color of editable comboboxes.

combobox_caret 

The color of the cared in editable comboboxes.

combobox_border 

The border color of comboboxes.

combobox_hover 

The background color of comboboxes when the mouse is hovered over them.

combobox_selected 

The border color of a selected combobox.

combobox_dropdown 

The background color of a combobox dropdown.

combobox_dropdown_hot 

The background color of a combobox dropdown when the mouse is hovered over it.

combobox_dropdown_arrow 

The line color of the combobox dropdown arrow.

combobox_dropdown_arrow_hot 

The line color of the combobox dropdown when the mouse is hovered over it.

line 

The color of lines.

line_hover 

The color of lines when the mouse is hovered over them.

line_selected 

The color of a selected line.

icon 

The background color of icons.

icon_border 

The color of icon borders.

icon_hot 

The background color of icons when the mouse is hovered over them.

icon_text 

The color of icon main text.

icon_description_text 

The color of icon description text.

strength_bar 

The background color of strength bars.

strength_bar_border 

The border color of strength bars.

badge 

The background color of badges.

badge_border 

The border color of badges.

badge_text 

The color of badge text.

◆ form_position

enum class liblec::lecui::form_position
strong

Form position.

Offset members use 10 pixels.

Enumerator
center_to_working_area 

Center the form to the working area. The working area is the desktop, minus the taskbar (if visible).

center_to_parent 

Center the form to its parent.

top_left 

Pin the form to the top left corner of the working area.

top_left_offset 

Pin the form to the top left corner of the working area, with an offset.

bottom_left 

Pin the form to the bottom left corner of the working area.

bottom_left_offset 

Pin the form to the bottom left corner of the working area, with an offset.

top_right 

Pin the form to the top right corner of the working area.

top_right_offset 

Pin the form to the top right corner of the working area, with an offset.

bottom_right 

Pin the form to the bottom right corner of the working area.

bottom_right_offset 

Pin the form to the bottom right corner of the working area, with an offset.

◆ image_quality

enum class liblec::lecui::image_quality
strong

Image render quality. Used when resampling images.

Enumerator
low 

Low image quality, for faster rendering.

medium 

Medium image quality, for a balance between quality and rendering speed.

high 

High image quality, for best image quality possibly at the cost of rendering speed.

◆ paragraph_alignment

Paragraph alignment.

Enumerator
top 

Align paragraph to the top.

middle 

Align paragraph to the middle.

bottom 

Align paragraph to the bottom.

◆ sort_options

enum class liblec::lecui::sort_options
strong

Sort options.

Enumerator
ascending 

Sort in ascending order.

descending 

Sort in descending order.

none 

No sorting order specified.

◆ text_alignment

enum class liblec::lecui::text_alignment
strong

Text alignment.

Enumerator
left 

Align text to the left edge.

center 

Align text to the center.

right 

Align text to the right.

justified 

Justify the text.

◆ themes

enum class liblec::lecui::themes
strong

Themes that are implemented within the library.

Enumerator
light 

The default theme. Best in bright environments.

dark 

Easier on the eyes in darker environments.

Function Documentation

◆ unique_string()

std::string lecui_api liblec::lecui::unique_string ( )

Make a unique string.

Returns
A unique string, e.g. 705c03bb-992f-40f1-841d-621bacc13eee.

The strings are guaranteed to be universally unique (universally unique identifier, or uuid for short).

◆ unique_string_short()

std::string lecui_api liblec::lecui::unique_string_short ( )

Make a short unique string.

Returns
A short unique string, e.g. e5dc5cfb.

The shortening is made possible through the truncation of an internally generated universally unique string; as such, these strings are not guaranteed to be universally unique. The probability of a clash, however, is infinitesimal.

◆ version()

std::string lecui_api liblec::lecui::version ( )

Get the version of the lecui library.

Returns
Returns the version number as a string in the form "lecui 1.0.0, 04 Jan 2019".