Drag[en]gine Script Module DragonScript Script API  1.0
ProgressBar Class Reference

Show progress of value inside range. More...

Inheritance diagram for ProgressBar:
Widget RangeModelNotifier

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...
 
int 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 (int orientation)
 Create progress bar widget. More...
 
ProgressBar new (int 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 (int 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 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...
 
void dispose ()
 
Widget findFocusableWidget ()
 
Widget findLastFocusableWidget ()
 
CanvasCreator getBackgroundCanvasCreator ()
 Background canvas creator or null to use background color. 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 ()
 
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 ()
 
GuiTheme getGuiTheme ()
 Gui theme to use for this widget. More...
 
bool getHasFocus ()
 
int getHeight ()
 Height of widget. More...
 
RangeModel getHorizontalRangeModel ()
 Horizontal range model for viewports to synchronize the horizontal scrollbar. More...
 
Point getMinimumSize ()
 
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 getThemeSelector ()
 Gui theme selector or null if not used. 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 isGuiThemeSet ()
 
bool isMinimumSizeSet ()
 
bool isMouseInside ()
 Mouse is hovering over this widget. More...
 
bool isPointInside (Point position)
 
bool isTransformationSet ()
 
void layoutParent ()
 
Widget new ()
 Create widget. More...
 
Widget new (int x, int y, int width, int height)
 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 onButtonPress (MouseEvent event)
 
void onButtonRelease (MouseEvent event)
 
void onDesignerChanged ()
 Designer changed. More...
 
void onDesignerSelectorChanged ()
 Designer selector changed. More...
 
void onDispose (WidgetEvent event)
 Window is disposing. More...
 
void onDragDrop (DragEvent event)
 
void onDragEnter (DragEvent event)
 
void onDragLeave (DragEvent event)
 
void onDragOver (DragEvent event)
 
void onFocusLost (FocusEvent event)
 Widget lost focus. More...
 
void onFocusReceived (FocusEvent event)
 Widget received focus. More...
 
void onGamepadAxisMoved (GamepadEvent event)
 Gamepad axis has been moved. More...
 
void onGamepadButtonPressed (GamepadEvent event)
 Gamepad button has been pressed. More...
 
void onGamepadButtonReleased (GamepadEvent event)
 Gamepad button has been released. More...
 
void onGuiThemeChanged ()
 
void onHidden (WidgetEvent event)
 Widget has been hidden. More...
 
void onKeyPress (KeyEvent event)
 
void onKeyRelease (KeyEvent event)
 
void onMouseEnter (MouseEvent event)
 
void onMouseLeave (MouseEvent event)
 
void onMouseMove (MouseEvent event)
 
void onMouseWheel (MouseEvent event)
 Mouse wheel has moved. More...
 
void onPaddingChanged ()
 Padding changed. More...
 
void onParentStateChanged ()
 Parent state changed. More...
 
void onReposition (WidgetEvent event)
 Position changed. More...
 
void onResize (WidgetEvent event)
 Size changed. More...
 
void onSetBackgroundColor ()
 
void onSetFont ()
 
void onSetTextColor ()
 Text color changed. More...
 
void onShown (WidgetEvent event)
 Widget has been shown. More...
 
void onStateChanged (StateChangeEvent event)
 State changed. 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)
 
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 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 setBorder (Border border)
 
void setCanFocus (bool canFocus)
 
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 setGuiTheme (GuiTheme theme)
 
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 setThemeSelector (String selector)
 Set gui theme selector or null if not used. 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 stopRepeatEventTimer ()
 
void updateCanvasBackground ()
 Update background canvas content. More...
 

Public Attributes

final int HORIZONTAL = 1
 Horizontal orientation. More...
 
final int VERTICAL = 2
 Vertical orientation. More...
 

Protected Member Functions

void updateLabelCanvasParams ()
 Update label canvas font, color and visibility. More...
 
void updateProgress ()
 Update progress. More...
 
- Protected Member Functions inherited from Widget
WidgetDesigner getDesignerFromTheme ()
 Get designer from gui theme. More...
 

Detailed Description

Show progress of value inside range.

Supports designing using designer selector "ProgressBar".

Member Function Documentation

◆ dispose()

void dispose ( )

Disposes of widget.

◆ getBarCanvasCreator()

CanvasCreator getBarCanvasCreator ( )

Bar canvas creator or null to show no bar.

◆ getInvertColorOverBar()

bool getInvertColorOverBar ( )

Invert color for text over bar.

◆ getMinimumSize()

Point getMinimumSize ( )

Minimal size of widget.

◆ getModel()

RangeModel getModel ( )

Model.

◆ getOrientation()

int getOrientation ( )

Orientation.

◆ getPercentage()

float getPercentage ( )

Progress percentage in the range from 0 to 1.

◆ getShowPercentage()

bool getShowPercentage ( )

Show percentage label.

◆ new() [1/3]

ProgressBar new ( )

Create horizontal progress bar widget.

◆ new() [2/3]

ProgressBar new ( int  orientation)

Create progress bar widget.

◆ new() [3/3]

ProgressBar new ( int  orientation,
RangeModel  model 
)

Create progress bar widget with model.

◆ onGuiThemeChanged()

void onGuiThemeChanged ( )

Gui theme changed.

◆ onResize()

void onResize ( WidgetEvent  event)

Size changed.

◆ onSetFont()

void onSetFont ( )

Widget font changed.

◆ onSetTextColor()

void onSetTextColor ( )

Text color changed.

◆ rangeChanged()

void rangeChanged ( RangeModel  rangeModel)

Range model minimum, maximum or page size changed.

Implements RangeModelNotifier.

◆ setBarCanvasCreator()

void setBarCanvasCreator ( CanvasCreator  creator)

Set bar canvas creator or null to show no bar.

◆ setInvertColorOverBar()

void setInvertColorOverBar ( bool  invert)

Set if color for text over bar is inverted.

◆ setModel()

void setModel ( RangeModel  model)

Set model.

◆ setOrientation()

void setOrientation ( int  orientation)

Set oriantation.

◆ setShowPercentage()

void setShowPercentage ( bool  show)

Set if percentage label is shown.

◆ updateLabelCanvasParams()

void updateLabelCanvasParams ( )
protected

Update label canvas font, color and visibility.

◆ updateProgress()

void updateProgress ( )
protected

Update progress.

◆ valueChanged()

void valueChanged ( RangeModel  rangeModel)

Range model value changed.

Implements RangeModelNotifier.

Member Data Documentation

◆ HORIZONTAL

final int HORIZONTAL = 1

Horizontal orientation.

◆ VERTICAL

final int VERTICAL = 2

Vertical orientation.


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