[][src]Crate orbtk_widgets

Base OrbTk widget library.

Modules

behaviors

Behavior widgets are provides a default set of event actions like mouse event handling. Use them as child to expand the event behavior of your widget.

prelude

Structs

Button

The Button widget can be clicked by user. It's used to perform an action.

ButtonCtx

Represents a widget context that provides methods to access the properties of a widget.

Canvas

Canvas is used to render 3D graphics.

CanvasCtx

Represents a widget context that provides methods to access the properties of a widget.

CheckBox

The CheckBox widget can be switch its selected state. It contains a selection box and a text.

CheckBoxCtx

Represents a widget context that provides methods to access the properties of a widget.

ComboBox

The ComboBox represents an selection widget with a drop-down list.

ComboBoxCtx

Represents a widget context that provides methods to access the properties of a widget.

ComboBoxItem

The ComboBoxItem describes an item inside of a ComboBox.

ComboBoxItemCtx

Represents a widget context that provides methods to access the properties of a widget.

ComboBoxItemState

The ComboBoxItemState handles the interaction an selection of a ComboBoxItem.

ComboBoxState

The ComboBoxState is used to manipulate the position of the thumb of the slider widget.

Container

The Container layout widget surrounds its child with a padding. Draws a box around the child.

ContainerCtx

Represents a widget context that provides methods to access the properties of a widget.

Cursor

The Cursor widget represents a text cursor used to mark text.

CursorCtx

Represents a widget context that provides methods to access the properties of a widget.

CursorState
FontIconBlock

The FontIconBlock widget is used to draw text. It is not interactive.

FontIconBlockCtx

Represents a widget context that provides methods to access the properties of a widget.

Grid

The Grid defines a flexible grid area that consists of columns and rows.

GridCtx

Represents a widget context that provides methods to access the properties of a widget.

ImageWidget

The ImageWidget widget is used to draw an image. It is not interactive.

ImageWidgetCtx

Represents a widget context that provides methods to access the properties of a widget.

ItemsWidget

The ItemsWidget is a simple no interactive items drawer widget.

ItemsWidgetCtx

Represents a widget context that provides methods to access the properties of a widget.

ItemsWidgetState
ListView

The ListView is an items drawer widget with selectable items.

ListViewCtx

Represents a widget context that provides methods to access the properties of a widget.

ListViewItem

The ListViewItem describes an item inside of a ListView.

ListViewItemCtx

Represents a widget context that provides methods to access the properties of a widget.

ListViewItemState

The ListViewItemState handles the interaction and selection of a ListViewItem.

ListViewState

The ListViewState generates the list box items and handles the selected indices.

NumericBox

NumericBox is used to let the user increase or decrease the value of the input by a given, fixed value called step until it reaches the upper or lower bounds. The widget can be controlled by clicking on the two control buttons, or the keybaord's Up and Down, Numpad+ and Numpad- keys, or the mouse scroll. Note: after the widget is initialized, changing the min, max or step properties has no effect.

NumericBoxCtx

Represents a widget context that provides methods to access the properties of a widget.

NumericBoxState
Popup

The Popup is used to display content that floats over the main content.

PopupCtx

Represents a widget context that provides methods to access the properties of a widget.

PopupState

The PopupState handles the open and close behavior of the Popup widget.

ProgressBar

The ProgressBar widget is used to indicating a finite progress (e.g. copying a file, downloading a video from the internet). A progress is visually represented as a horizontal bar which grows when the progress advances. The ProgressBar expects values between 0.0 and 1.0, whereas 0.0 means 0%, and 1.0 means 100%. Any value outside of this range considered as 100%.

ProgressBarCtx

Represents a widget context that provides methods to access the properties of a widget.

ScrollBar

The ScrollBar widget represents a position inside of a scroll container.

ScrollBarCtx

Represents a widget context that provides methods to access the properties of a widget.

ScrollIndicator

The ScrollIndicator widget contains two scroll bars.

ScrollIndicatorCtx

Represents a widget context that provides methods to access the properties of a widget.

ScrollIndicatorState

The ScrollIndicatorState handles the ScrollIndicator widget.

ScrollViewer

The ScrollViewer is used to scroll its child vertical and or horizontal. Only the first child of the scroll viewer can be scrolled.

ScrollViewerCtx

Represents a widget context that provides methods to access the properties of a widget.

ScrollViewerState

The ScrollViewerState handles the ScrollViewer widget.

Slider

The Slider allows to use a val in a range of values.

SliderCtx

Represents a widget context that provides methods to access the properties of a widget.

SliderState

The SliderState is used to manipulate the position of the thumb of the slider widget.

Stack

The Stack defines a layout that is used to stack its children vertical or horizontal.

StackCtx

Represents a widget context that provides methods to access the properties of a widget.

Switch

The Switch widget can be switch between on and off.

SwitchCtx

Represents a widget context that provides methods to access the properties of a widget.

SwitchState

State to handle the position of switch toggle.

TabHeader

The TabHeader widget is used internally to managed tabs headers. Not meant for other uses.

TabHeaderCtx

Represents a widget context that provides methods to access the properties of a widget.

TabHeaderState

The TabHeaderState is used to store some callbacks that will be applied during template function. Once the template function is called, they are no more used.

TabWidget

The TabWidget widget can store and control multiple tabs with arbitrary content. Only the selected tab will show it's content.

TabWidgetCtx

Represents a widget context that provides methods to access the properties of a widget.

TabWidgetState

Through the TabWidgetState it is possible to control the behaviour of TabWidget. Nearly every called function on TabWidgetState will not be executed immediatly, but they are instead stored and executed during the update phase, in the same order they are submitted.

TextBlock

The TextBlock widget is used to draw text. It is not interactive.

TextBlockCtx

Represents a widget context that provides methods to access the properties of a widget.

TextBox

The TextBox widget represents a single line text input widget.

TextBoxCtx

Represents a widget context that provides methods to access the properties of a widget.

ToggleButton

The ToggleButton widget can be clicked by user and could switch between selected / not selected. It's used to perform an action.

ToggleButtonCtx

Represents a widget context that provides methods to access the properties of a widget.

Window

The Window widget provides access to the properties of an application window. It also contains global properties like keyboard modifier and focused widget.

WindowCtx

Represents a widget context that provides methods to access the properties of a widget.

Enums

InputAction

Statics

ID_INPUT
STYLE_BTN
STYLE_INPUT
STYLE_PROGRESS_BAR
STYLE_PROGRESS_BAR_INDICATOR
STYLE_SCROLL_BAR
STYLE_SLIDER
STYLE_TEXT_BOX
STYLE_WINDOW

Functions

button

Gets a context wrapper to access the properties of the widget.

canvas

Gets a context wrapper to access the properties of the widget.

check_box

Gets a context wrapper to access the properties of the widget.

combo_box

Gets a context wrapper to access the properties of the widget.

combo_box_item

Gets a context wrapper to access the properties of the widget.

container

Gets a context wrapper to access the properties of the widget.

cursor

Gets a context wrapper to access the properties of the widget.

font_icon_block

Gets a context wrapper to access the properties of the widget.

grid

Gets a context wrapper to access the properties of the widget.

image_widget

Gets a context wrapper to access the properties of the widget.

items_widget

Gets a context wrapper to access the properties of the widget.

list_view

Gets a context wrapper to access the properties of the widget.

list_view_item

Gets a context wrapper to access the properties of the widget.

numeric_box

Gets a context wrapper to access the properties of the widget.

popup

Gets a context wrapper to access the properties of the widget.

progress_bar

Gets a context wrapper to access the properties of the widget.

scroll_bar

Gets a context wrapper to access the properties of the widget.

scroll_indicator

Gets a context wrapper to access the properties of the widget.

scroll_viewer

Gets a context wrapper to access the properties of the widget.

slider

Gets a context wrapper to access the properties of the widget.

stack

Gets a context wrapper to access the properties of the widget.

switch

Gets a context wrapper to access the properties of the widget.

tab_header

Gets a context wrapper to access the properties of the widget.

tab_widget

Gets a context wrapper to access the properties of the widget.

text_block

Gets a context wrapper to access the properties of the widget.

text_box

Gets a context wrapper to access the properties of the widget.

toggle_button

Gets a context wrapper to access the properties of the widget.

window

Gets a context wrapper to access the properties of the widget.