Dragengine.Gui.ProgressBar Class Reference
Show progress of value inside range. More...
Inheritance diagram for Dragengine.Gui.ProgressBar:
Public Member Functions | |
| void | dispose () |
| Disposes of widget. More... | |
| CanvasCreator | getBarCanvasCreator () |
| Bar canvas creator or null to show no bar. More... | |
| bool | getInvertColorOverBar () |
| Invert color for text over bar. More... | |
| Point | getMinimumSize () |
| Minimal size of widget. More... | |
| RangeModel | getModel () |
| Model. More... | |
| Orientation | getOrientation () |
| Orientation. More... | |
| float | getPercentage () |
| Progress percentage in the range from 0 to 1. More... | |
| bool | getShowPercentage () |
| Show percentage label. More... | |
| ProgressBar | new () |
| Create horizontal progress bar widget. More... | |
| ProgressBar | new (Orientation orientation) |
| Create progress bar widget. More... | |
| ProgressBar | new (Orientation orientation, RangeModel model) |
| Create progress bar widget with model. More... | |
| void | onGuiThemeChanged () |
| Gui theme changed. More... | |
| void | onResize (WidgetEvent event) |
| Size changed. More... | |
| void | onSetFont () |
| Widget font changed. More... | |
| void | onSetTextColor () |
| Text color changed. More... | |
| void | rangeChanged (RangeModel rangeModel) |
| Range model minimum, maximum or page size changed. More... | |
| void | setBarCanvasCreator (CanvasCreator creator) |
| Set bar canvas creator or null to show no bar. More... | |
| void | setInvertColorOverBar (bool invert) |
| Set if color for text over bar is inverted. More... | |
| void | setModel (RangeModel model) |
| Set model. More... | |
| void | setOrientation (Orientation orientation) |
| Set oriantation. More... | |
| void | setShowPercentage (bool show) |
| Set if percentage label is shown. More... | |
| void | valueChanged (RangeModel rangeModel) |
| Range model value changed. More... | |
 Public Member Functions inherited from Dragengine.Gui.Widget | |
| void | addDragListener (DragListener listener) |
| void | addFocusListener (FocusListener listener) |
| Add focus listener. More... | |
| void | addGamepadListener (GamepadListener listener) |
| Add gamepad listener. More... | |
| void | addKeyListener (KeyListener listener) |
| void | addMouseListener (MouseListener listener) |
| void | addStateChangeListener (StateChangeListener listener) |
| Add state change listener. More... | |
| void | addWidgetListener (WidgetListener listener) |
| Add widget listener. More... | |
| bool | canGrabFullFocus () |
| void | captureMouse () |
| void | design () |
| Design widget using WidgetDesigner. More... | |
| Widget | findFocusableWidget () |
| Widget | findLastFocusableWidget () |
| CanvasCreator | getBackgroundCanvasCreator () |
| Background canvas creator or null to use background color. More... | |
| bool | getBlockLayoutParent () |
| Block layoutParent calls. More... | |
| Border | getBorder () |
| BorderSize | getBorderSize () |
| RectArea | getBoundary () |
| Rectangulare boundary of the widget. More... | |
| RectArea | getBoundaryWithBorder () |
| Rectangulare boundary of the widget including border. More... | |
| bool | getCanFocus () |
| CanvasView | getCanvasBackground () |
| CanvasView | getCanvasContent () |
| CanvasView | getCanvasWidget () |
| Clipboard | getClipboard () |
| Clipboard or null to use parent clipboard. More... | |
| ColorMatrix | getColorTransformation () |
| Color transformation. More... | |
| WidgetDesigner | getDesigner () |
| Designer. More... | |
| String | getDesignerSelector () |
| Designer selector. More... | |
| Desktop | getDesktop () |
| Point | getDesktopPosition () |
| Widget position in desktop coordinates. More... | |
| bool | getEnabled () |
| MousePointerFactory | getFirstMousePointer () |
| First assigned mouse pointer. More... | |
| Font | getFont () |
| bool | getHasBlockedLayoutParent () |
| layoutParent calls happened during runWhileBlockingLayoutParent. More... | |
| bool | getHasFocus () |
| int | getHeight () |
| Height of widget. More... | |
| RangeModel | getHorizontalRangeModel () |
| Horizontal range model for viewports to synchronize the horizontal scrollbar. More... | |
| Widget | getHoverWidget () |
| Widget the mouse hovers above or null. More... | |
| Point | getLocalMouseLocation () |
| Parent desktop mouse location in widget coordinates. More... | |
| Point | getMinimumSizeForHeight (int height) |
| Minimum size of widget using reference widget height and variable width. More... | |
| Point | getMinimumSizeForWidth (int width) |
| Minimum size of widget using reference widget width and variable height. More... | |
| Point | getMinimumSizeWithBorder () |
| Point | getMinimumSizeWithBorderForHeight (int height) |
| Minimum size of widget with border using reference height. More... | |
| Point | getMinimumSizeWithBorderForWidth (int width) |
| Minimum size of widget with border for reference width. More... | |
| MousePointerFactory | getMousePointer () |
| Mouse pointer to use. More... | |
| BorderSize | getPadding () |
| Padding. More... | |
| Container | getParent () |
| Point | getPosition () |
| Position of the widget. More... | |
| bool | getProtectBackgroundCanvasCreator () |
| Protect custom set background canvas creator. More... | |
| bool | getProtectBorder () |
| Protect custom set border. More... | |
| bool | getProtectFont () |
| Protect custom set font. More... | |
| bool | getProtectMinimumSize () |
| Protect custom set minimumsize. More... | |
| bool | getProtectMousePointer () |
| Protect custom set mouse pointer. More... | |
| bool | getProtectPadding () |
| Protect custom set padding. More... | |
| bool | getProtectTextColor () |
| Protect custom set text color. More... | |
| Point | getRelativePosition (Container parent) |
| Widget position in parent widget coordinates. More... | |
| Point | getScreenPosition () |
| Widget position in screen coordinates. More... | |
| RectArea | getScreenRectArea () |
| Point | getSetMinimumSize () |
| Point | getSize () |
| Size of the widget. More... | |
| Color | getTextColor () |
| Text color. More... | |
| String | getTitle () |
| Widget title. More... | |
| Object | getToolTip () |
| Tooltip or null. More... | |
| float | getTotalTransparency () |
| TexMatrix2 | getTransformation () |
| float | getTransparency () |
| RangeModel | getVerticalRangeModel () |
| Vertical range model for viewports to synchronize the vertical scrollbar. More... | |
| bool | getVisible () |
| Widget | getWidgetAt (Point position) |
| Widget at coordinates or null if not found. More... | |
| int | getWidth () |
| Width of widget. More... | |
| Window | getWindow () |
| Point | getWindowPosition () |
| Widget position in window coordinates. More... | |
| int | getX () |
| X position of widget. More... | |
| int | getY () |
| Y position of widget. More... | |
| void | grabFocus () |
| bool | hasParent (Container container) |
| bool | isDesignerSet () |
| Custom designer is set. More... | |
| bool | isFullEnabled () |
| Widget and all parent widgets are enabled. More... | |
| bool | isMinimumSizeSet () |
| bool | isMouseInside () |
| Mouse is hovering over this widget. More... | |
| bool | isPointInside (Point position) |
| bool | isTransformationSet () |
| void | layoutParent () |
| void | layoutParentIfBlocked () |
| Calls layoutParent if getHasBlockedLayoutParent() is true. More... | |
| Widget | new (int x, int y, int width, int height) |
| Create widget with initial location and size. More... | |
| Widget | new (Point position, Point size) |
| Create widget with initial location and size. More... | |
| Widget | nextFocusWidget () |
| Find next widget in the focus cycle that can grab the focus. More... | |
| void | notifyBorderParametersChanged () |
| void | onDesignerChanged () |
| Designer changed. More... | |
| void | onDesignerSelectorChanged () |
| Designer selector changed. More... | |
| void | onDispose (WidgetEvent event) |
| Window is disposing. More... | |
| void | onFocusLost (FocusEvent event) |
| Widget lost focus. More... | |
| void | onFocusReceived (FocusEvent event) |
| Widget received focus. More... | |
| void | onFrameUpdate (float elapsed) |
| Do frame update. More... | |
| void | onGamepadButtonPressed (GamepadEvent event) |
| Gamepad button has been pressed. More... | |
| void | onGamepadButtonReleased (GamepadEvent event) |
| Gamepad button has been released. More... | |
| void | onHidden (WidgetEvent event) |
| Widget has been hidden. More... | |
| void | onPaddingChanged () |
| Padding changed. More... | |
| void | onParentStateChanged () |
| Parent state changed. More... | |
| void | onParentStateChanged (bool force) |
| Parent state changed. More... | |
| void | onReposition (WidgetEvent event) |
| Position changed. More... | |
| void | onShown (WidgetEvent event) |
| Widget has been shown. More... | |
| void | onStateChanged (StateChangeEvent event) |
| State changed. More... | |
| void | onTranslationChanged () |
| Translation manager or active language pack changed. More... | |
| void | popdownVirtualKeyboard () |
| Popdown virtual keyboard if Desktop has one assigned. More... | |
| void | popupVirtualKeyboard () |
| Popup virtual keyboard if Desktop has one assigned. More... | |
| Widget | prevFocusWidget () |
| Find previous widget in the focus cycle that can grab the focus. More... | |
| void | processEvent (Event event) |
| void | releaseMouse () |
| void | removeDragListener (DragListener listener) |
| void | removeFocusListener (FocusListener listener) |
| Remove focus listener. More... | |
| void | removeGamepadListener (GamepadListener listener) |
| Remove gamepad listener. More... | |
| void | removeKeyListener (KeyListener listener) |
| void | removeMouseListener (MouseListener listener) |
| void | removeStateChangeListener (StateChangeListener listener) |
| Remove state change listener. More... | |
| void | removeWidgetListener (WidgetListener listener) |
| Remove widget listener. More... | |
| void | requestGrabFocus (Widget widget) |
| void | runWhileBlockingLayoutParent (Block ablock) |
| Run block while layouting is blocked. More... | |
| void | safeDispose () |
| Safely dispose of widget. More... | |
| void | sendEvent (Event event) |
| void | sendEventToListeners (Event event, bool sendToParent) |
| Send event to all appropriate listeners for events of its kind. More... | |
| void | setBackgroundCanvasCreator (CanvasCreator creator) |
| Set background canvas creator or null to use background color. More... | |
| void | setBlockLayoutParent (bool blockLayoutParent) |
| Set block layoutParent calls. More... | |
| void | setBorder (Border border) |
| void | setCanFocus (bool canFocus) |
| void | setClipboard (Clipboard clipboard) |
| Set clipboard or null to use parent clipboard. More... | |
| void | setColorTransformation (ColorMatrix transformation) |
| Set color transformation. More... | |
| void | setDesigner (WidgetDesigner designer) |
| Set designer. More... | |
| void | setDesignerSelector (String selector) |
| Set designer selector. More... | |
| void | setEnabled (bool enabled) |
| void | setFont (Font font) |
| void | setHasBlockedLayoutParent (bool hasBlockedLayoutParent) |
| Set if layoutParent calls happened during runWhileBlockingLayoutParent. More... | |
| void | setHasFocus (bool hasFocus) |
| void | setHeight (int height) |
| Set height of widget. More... | |
| void | setMinimumSize (Point size) |
| void | setMousePointer (MousePointerFactory mousePointer) |
| Set mouse pointer to use. More... | |
| void | setPadding (BorderSize padding) |
| Set padding. More... | |
| void | setParent (Container parent) |
| void | setPosition (Point position) |
| Set position of widget. More... | |
| void | setProtectBackgroundCanvasCreator (bool protect) |
| Set protect custom set background canvas creator. More... | |
| void | setProtectBorder (bool protect) |
| Set protect custom set border. More... | |
| void | setProtectFont (bool protect) |
| Set protect custom set font. More... | |
| void | setProtectMinimumSize (bool protect) |
| Set protect custom set minimumsize. More... | |
| void | setProtectMousePointer (bool protect) |
| Set protect custom set mouse pointer. More... | |
| void | setProtectPadding (bool protect) |
| Set protect custom set padding. More... | |
| void | setProtectTextColor (bool protect) |
| Set protect custom set text color. More... | |
| void | setSize (Point size) |
| Set size of widget. More... | |
| void | setTextColor (Color color) |
| Set text color. More... | |
| void | setTitle (String title) |
| Set widget title. More... | |
| void | setToolTip (Object toolTip) |
| Set tooltip or null. More... | |
| void | setTransformation (TexMatrix2 transformation) |
| void | setTransparency (float transparency) |
| void | setVisible (bool visible) |
| void | setWidth (int width) |
| Set width of widget. More... | |
| void | setX (int x) |
| Set X position of widget. More... | |
| void | setY (int y) |
| Set Y Position of widget. More... | |
| void | startFrameUpdater () |
| Start frame updater if not running. More... | |
| void | stopFrameUpdater () |
| Stop frame updater if running. More... | |
Protected Member Functions | |
| void | updateLabelCanvasParams () |
| Update label canvas font, color and visibility. More... | |
| void | updateProgress () |
| Update progress. More... | |
| Protected Member Functions inherited from Dragengine.Gui.Widget | |
| WidgetDesigner | getDesignerFromTheme () |
| Get designer from gui theme. More... | |
| void | updateCanvasBackground () |
| Update background canvas content. More... | |
| void | updateCanvasGeometry () |
| Update canvas position and size. More... | |
Detailed Description
Show progress of value inside range.
Supports designing using designer selector "ProgressBar".
Member Function Documentation
◆ dispose()
| void Dragengine.Gui.ProgressBar.dispose | ( | ) |
Disposes of widget.
Reimplemented from Dragengine.Gui.Widget.
◆ getBarCanvasCreator()
| CanvasCreator Dragengine.Gui.ProgressBar.getBarCanvasCreator | ( | ) |
Bar canvas creator or null to show no bar.
◆ getInvertColorOverBar()
| bool Dragengine.Gui.ProgressBar.getInvertColorOverBar | ( | ) |
Invert color for text over bar.
◆ getMinimumSize()
| Point Dragengine.Gui.ProgressBar.getMinimumSize | ( | ) |
Minimal size of widget.
Reimplemented from Dragengine.Gui.Widget.
◆ getModel()
| RangeModel Dragengine.Gui.ProgressBar.getModel | ( | ) |
Model.
◆ getOrientation()
| Orientation Dragengine.Gui.ProgressBar.getOrientation | ( | ) |
Orientation.
◆ getPercentage()
| float Dragengine.Gui.ProgressBar.getPercentage | ( | ) |
Progress percentage in the range from 0 to 1.
◆ getShowPercentage()
| bool Dragengine.Gui.ProgressBar.getShowPercentage | ( | ) |
Show percentage label.
◆ new() [1/3]
| ProgressBar Dragengine.Gui.ProgressBar.new | ( | ) |
Create horizontal progress bar widget.
Reimplemented from Dragengine.Gui.Widget.
◆ new() [2/3]
| ProgressBar Dragengine.Gui.ProgressBar.new | ( | Orientation | orientation | ) |
Create progress bar widget.
◆ new() [3/3]
| ProgressBar Dragengine.Gui.ProgressBar.new | ( | Orientation | orientation, |
| RangeModel | model | ||
| ) |
Create progress bar widget with model.
◆ onGuiThemeChanged()
| void Dragengine.Gui.ProgressBar.onGuiThemeChanged | ( | ) |
Gui theme changed.
Reimplemented from Dragengine.Gui.Widget.
◆ onResize()
| void Dragengine.Gui.ProgressBar.onResize | ( | WidgetEvent | event | ) |
Size changed.
Reimplemented from Dragengine.Gui.Widget.
◆ onSetFont()
| void Dragengine.Gui.ProgressBar.onSetFont | ( | ) |
Widget font changed.
Reimplemented from Dragengine.Gui.Widget.
◆ onSetTextColor()
| void Dragengine.Gui.ProgressBar.onSetTextColor | ( | ) |
Text color changed.
Reimplemented from Dragengine.Gui.Widget.
◆ rangeChanged()
| void Dragengine.Gui.ProgressBar.rangeChanged | ( | RangeModel | rangeModel | ) |
Range model minimum, maximum or page size changed.
Implements Dragengine.Gui.RangeModelListener.
◆ setBarCanvasCreator()
| void Dragengine.Gui.ProgressBar.setBarCanvasCreator | ( | CanvasCreator | creator | ) |
Set bar canvas creator or null to show no bar.
◆ setInvertColorOverBar()
| void Dragengine.Gui.ProgressBar.setInvertColorOverBar | ( | bool | invert | ) |
Set if color for text over bar is inverted.
◆ setModel()
| void Dragengine.Gui.ProgressBar.setModel | ( | RangeModel | model | ) |
Set model.
◆ setOrientation()
| void Dragengine.Gui.ProgressBar.setOrientation | ( | Orientation | orientation | ) |
Set oriantation.
◆ setShowPercentage()
| void Dragengine.Gui.ProgressBar.setShowPercentage | ( | bool | show | ) |
Set if percentage label is shown.
◆ updateLabelCanvasParams()
|
protected |
Update label canvas font, color and visibility.
◆ updateProgress()
|
protected |
Update progress.
◆ valueChanged()
| void Dragengine.Gui.ProgressBar.valueChanged | ( | RangeModel | rangeModel | ) |
Range model value changed.
Implements Dragengine.Gui.RangeModelListener.
The documentation for this class was generated from the following file:
