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

Default implementation of WidgetDesigner for ProgressBar. More...

Inheritance diagram for DefaultProgressBarDesigner:
DefaultWidgetDesigner WidgetDesigner

Classes

class  ProgressBarStateDesign
 Design for particular widget state. More...
 

Public Member Functions

WidgetDesigner copyDesigner ()
 Create copy of designer. More...
 
void designWidget (Widget widget)
 Design widget. More...
 
CanvasCreator getCreatorBar ()
 Canvas creator for progress bar. More...
 
ProgressBarStateDesign getProgressBarDesignDisabled ()
 Design for disabled state. More...
 
ProgressBarStateDesign getProgressBarDesignFocused ()
 Design for focused state. More...
 
ProgressBarStateDesign getProgressBarDesignFocusedHover ()
 Design for focused hover state. More...
 
ProgressBarStateDesign getProgressBarDesignHover ()
 Design for hover state. More...
 
ProgressBarStateDesign getProgressBarDesignNormal ()
 Design for normal state. More...
 
DefaultProgressBarDesigner new ()
 Create new progress bar designer. More...
 
DefaultProgressBarDesigner new (DefaultProgressBarDesigner designer)
 Create copy of widget designer. More...
 
void setCreatorBar (CanvasCreator creator)
 Set canvas creator for progress bar. More...
 
void setParameter (String name, Object value)
 Set parameter. More...
 
- Public Member Functions inherited from DefaultWidgetDesigner
WidgetDesigner copyDesigner ()
 Create copy of designer. More...
 
void designWidget (Widget widget)
 Design widget. More...
 
StateDesign getDesignDisabled ()
 Design for disabled state. More...
 
StateDesign getDesignFocused ()
 Design for focused state. More...
 
StateDesign getDesignFocusedHover ()
 Design for focused hover state. More...
 
StateDesign getDesignHover ()
 Design for hover state. More...
 
StateDesign getDesignNormal ()
 Design for normal state. More...
 
DefaultWidgetDesigner new ()
 Create new widget designer. More...
 
DefaultWidgetDesigner new (DefaultWidgetDesigner designer)
 Create copy of widget designer. More...
 
void setParameter (String name, Object value)
 Set parameter. More...
 

Additional Inherited Members

- Protected Member Functions inherited from DefaultWidgetDesigner
StateDesign getNamedStateDesign (String stateName)
 Get state for parameter name selector component or null if not found. More...
 
void setDesignDisabled (StateDesign design)
 Set design for disabled state. More...
 
void setDesignFocused (StateDesign design)
 Set design for focused state. More...
 
void setDesignFocusedHover (StateDesign design)
 Set design for focused hover state. More...
 
void setDesignHover (StateDesign design)
 Set design for hover state. More...
 
void setDesignNormal (StateDesign design)
 Set design for normal state. More...
 
StateDesign widgetStateFindDesign (Widget widget)
 Get design to apply to widget. More...
 

Detailed Description

Default implementation of WidgetDesigner for ProgressBar.

Todo:

Add parameter to define if the label should be inverted or not. For certain fonts this is not required and looks wrong.

Add parameter to define if a label is shown or not. A transparent color can be used to hide the label but it still affects the minimum size of the bar. Without a label the bar can be made much smaller if desired.

Member Function Documentation

◆ copyDesigner()

WidgetDesigner copyDesigner ( )

Create copy of designer.

Implements WidgetDesigner.

◆ designWidget()

void designWidget ( Widget  widget)

Design widget.

Implements WidgetDesigner.

◆ getCreatorBar()

CanvasCreator getCreatorBar ( )

Canvas creator for progress bar.

◆ getProgressBarDesignDisabled()

ProgressBarStateDesign getProgressBarDesignDisabled ( )

Design for disabled state.

◆ getProgressBarDesignFocused()

ProgressBarStateDesign getProgressBarDesignFocused ( )

Design for focused state.

◆ getProgressBarDesignFocusedHover()

ProgressBarStateDesign getProgressBarDesignFocusedHover ( )

Design for focused hover state.

◆ getProgressBarDesignHover()

ProgressBarStateDesign getProgressBarDesignHover ( )

Design for hover state.

◆ getProgressBarDesignNormal()

ProgressBarStateDesign getProgressBarDesignNormal ( )

Design for normal state.

◆ new() [1/2]

Create new progress bar designer.

◆ new() [2/2]

Create copy of widget designer.

◆ setCreatorBar()

void setCreatorBar ( CanvasCreator  creator)

Set canvas creator for progress bar.

◆ setParameter()

void setParameter ( String  name,
Object  value 
)

Set parameter.

See DefaultButtonDesigner.setParameter for supported parameters.

Additional supported parameters: | name | value | Setter | | {state}.showPercentage | bool | getDesign{state}.setShowPercentage | | {state}.invertColorOverBar | bool | getDesign{state}.setInvertColorOverBar | | bar | CanvasCreator | setCreatorBar |

Implements WidgetDesigner.


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