Drag[en]gine Script Module DragonScript  1.23
Dragengine.Gui.Slider.ActionSlide Class Reference

Action slide. More...

Inheritance diagram for Dragengine.Gui.Slider.ActionSlide:
Dragengine.Gui.Events.DefaultActionListener Dragengine.Gui.Events.ActionListener Dragengine.Gui.Slider.ActionSlide.ActionSlideDown Dragengine.Gui.Slider.ActionSlide.ActionSlideUp

Classes

class  ActionSlideDown
 Action slide down action. More...
 
class  ActionSlidePageDown
 Action slide page down action. More...
 
class  ActionSlidePageUp
 Action slide page up action. More...
 
class  ActionSlideUp
 Action slide up action. More...
 
enum  DragArea
 
class  DragKnobMouseListener
 Drag knob mouse listener. More...
 
class  KnobKeyListener
 Knob key listener. More...
 
class  SliderLayout
 Slider layout. More...
 

Public Member Functions

void dispose ()
 Dispose of widget. More...
 
void doLayout ()
 Layout widget. More...
 
int getKnobOffset ()
 Knob offset along orientation axis. More...
 
Point getKnobPosition (int value)
 Knob position matching model value. More...
 
int getKnobValue (Point position)
 Closest model value matching knob position. More...
 
RangeModel getModel ()
 Range model. More...
 
Orientation getOrientation ()
 Orientation. More...
 
bool getReverseWheel ()
 Reverse wheel direction. More...
 
bool getShowTicks ()
 Show ticks. More...
 
RectArea getSlideArea ()
 Slide area in pixels. More...
 
int getSliderSize ()
 Slider size along non-orientation axis. More...
 
float getSmallTickCountRatio ()
 Percentage of small ticks to show per large tick. More...
 
int getTickSize ()
 Tick size along orientation axis. More...
 
Widget getWidgetBar ()
 Bar widget. More...
 
Widget getWidgetKnob ()
 Knob widget. More...
 
ActionSlide new (Orientation orientation)
 Create slide widget. More...
 
ActionSlide new (Slider slider)
 
ActionSlide new (Slider slider, bool isWheelAction)
 
void onAction (ActionEvent event)
 Run action. More...
 
void onButtonPress (MouseEvent event)
 
void onButtonRelease (MouseEvent event)
 
void onDesignerChanged ()
 Designer changed. More...
 
void onGuiThemeChanged ()
 
void onResize (WidgetEvent event)
 Size changed. More...
 
void rangeChanged (RangeModel rangeModel)
 
void repositionKnob ()
 Reposition knob to match current model value. More...
 
void setEnabled (bool enabled)
 Set if widget is enabled. More...
 
void setModel (RangeModel model)
 Set range model. More...
 
void setOrientation (Orientation orientation)
 Set orientation. More...
 
void setReverseWheel (bool reverseWheel)
 Set reverse wheel direction. More...
 
void setShowTicks (bool showTicks)
 Set show ticks. More...
 
void setSmallTickCountRatio (float ratio)
 Set percentage of small ticks to show per large tick. More...
 
void valueChanged (RangeModel rangeModel)
 
- Public Member Functions inherited from Dragengine.Gui.Events.DefaultActionListener
DefaultActionListener new ()
 Create default action listener. More...
 

Protected Member Functions

void createContent ()
 
WidgetDesigner getDesignerFromTheme ()
 Get designer from gui theme. More...
 
bool increaseValue ()
 

Protected Attributes

bool pIsWheelAction
 
Slider pSlider
 

Detailed Description

Action slide.

Member Function Documentation

◆ createContent()

void Dragengine.Gui.Slider.ActionSlide.createContent ( )
protected

Create content widgets.

◆ dispose()

void Dragengine.Gui.Slider.ActionSlide.dispose ( )

Dispose of widget.

◆ doLayout()

void Dragengine.Gui.Slider.ActionSlide.doLayout ( )

Layout widget.

◆ getDesignerFromTheme()

WidgetDesigner Dragengine.Gui.Slider.ActionSlide.getDesignerFromTheme ( )
protected

Get designer from gui theme.

Modified to ensure a DefaultSliderDesigner is used if super.getDesignerFromTheme() returns null.

◆ getKnobOffset()

int Dragengine.Gui.Slider.ActionSlide.getKnobOffset ( )

Knob offset along orientation axis.

Stored value from designer.

◆ getKnobPosition()

Point Dragengine.Gui.Slider.ActionSlide.getKnobPosition ( int  value)

Knob position matching model value.

◆ getKnobValue()

int Dragengine.Gui.Slider.ActionSlide.getKnobValue ( Point  position)

Closest model value matching knob position.

◆ getModel()

RangeModel Dragengine.Gui.Slider.ActionSlide.getModel ( )

Range model.

◆ getOrientation()

Orientation Dragengine.Gui.Slider.ActionSlide.getOrientation ( )

Orientation.

◆ getReverseWheel()

bool Dragengine.Gui.Slider.ActionSlide.getReverseWheel ( )

Reverse wheel direction.

If false wheeling up decreases the range model. If true increases the range model.

◆ getShowTicks()

bool Dragengine.Gui.Slider.ActionSlide.getShowTicks ( )

Show ticks.

If page size in model is 1 shows only large ticks. Otherwise shows large ticks every page size step with small ticks for each value step. If the density is too large tick count is reduced.

◆ getSlideArea()

RectArea Dragengine.Gui.Slider.ActionSlide.getSlideArea ( )

Slide area in pixels.

For horizontal slider returns X coordinate of left and right slide end point and Y coordinate center of slider. For vertical slider returns Y coordinate of top and bottom slide end point and X coordinate center of slider.

◆ getSliderSize()

int Dragengine.Gui.Slider.ActionSlide.getSliderSize ( )

Slider size along non-orientation axis.

Stored value from designer.

◆ getSmallTickCountRatio()

float Dragengine.Gui.Slider.ActionSlide.getSmallTickCountRatio ( )

Percentage of small ticks to show per large tick.

Value is in the range from 0 to 1. Model page size is multiplied by this value to get the count of small ticks to show.

◆ getTickSize()

int Dragengine.Gui.Slider.ActionSlide.getTickSize ( )

Tick size along orientation axis.

Stored value from designer.

◆ getWidgetBar()

Widget Dragengine.Gui.Slider.ActionSlide.getWidgetBar ( )

Bar widget.

◆ getWidgetKnob()

Widget Dragengine.Gui.Slider.ActionSlide.getWidgetKnob ( )

Knob widget.

◆ increaseValue()

bool Dragengine.Gui.Slider.ActionSlide.increaseValue ( )
protected

◆ new() [1/3]

ActionSlide Dragengine.Gui.Slider.ActionSlide.new ( Orientation  orientation)

Create slide widget.

◆ new() [2/3]

ActionSlide Dragengine.Gui.Slider.ActionSlide.new ( Slider  slider)

◆ new() [3/3]

ActionSlide Dragengine.Gui.Slider.ActionSlide.new ( Slider  slider,
bool  isWheelAction 
)

◆ onAction()

void Dragengine.Gui.Slider.ActionSlide.onAction ( ActionEvent  event)

Run action.

Reimplemented from Dragengine.Gui.Events.DefaultActionListener.

◆ onButtonPress()

void Dragengine.Gui.Slider.ActionSlide.onButtonPress ( MouseEvent  event)

Mouse button has been pressed.

◆ onButtonRelease()

void Dragengine.Gui.Slider.ActionSlide.onButtonRelease ( MouseEvent  event)

Mouse button has been released.

◆ onDesignerChanged()

void Dragengine.Gui.Slider.ActionSlide.onDesignerChanged ( )

Designer changed.

◆ onGuiThemeChanged()

void Dragengine.Gui.Slider.ActionSlide.onGuiThemeChanged ( )

Notification that the gui theme changed.

◆ onResize()

void Dragengine.Gui.Slider.ActionSlide.onResize ( WidgetEvent  event)

Size changed.

◆ rangeChanged()

void Dragengine.Gui.Slider.ActionSlide.rangeChanged ( RangeModel  rangeModel)

Send if the outer range properties like minimum value, maximum value or page size has changed.

◆ repositionKnob()

void Dragengine.Gui.Slider.ActionSlide.repositionKnob ( )

Reposition knob to match current model value.

◆ setEnabled()

void Dragengine.Gui.Slider.ActionSlide.setEnabled ( bool  enabled)

Set if widget is enabled.

◆ setModel()

void Dragengine.Gui.Slider.ActionSlide.setModel ( RangeModel  model)

Set range model.

◆ setOrientation()

void Dragengine.Gui.Slider.ActionSlide.setOrientation ( Orientation  orientation)

Set orientation.

◆ setReverseWheel()

void Dragengine.Gui.Slider.ActionSlide.setReverseWheel ( bool  reverseWheel)

Set reverse wheel direction.

If false wheeling up decreases the range model. If true increases the range model.

◆ setShowTicks()

void Dragengine.Gui.Slider.ActionSlide.setShowTicks ( bool  showTicks)

Set show ticks.

If page size in model is 1 shows only large ticks. Otherwise shows large ticks every page size step with small ticks for each value step. If the density is too large tick count is reduced.

◆ setSmallTickCountRatio()

void Dragengine.Gui.Slider.ActionSlide.setSmallTickCountRatio ( float  ratio)

Set percentage of small ticks to show per large tick.

Value is in the range from 0 to 1. Model page size is multiplied by this value to get the count of small ticks to show.

◆ valueChanged()

void Dragengine.Gui.Slider.ActionSlide.valueChanged ( RangeModel  rangeModel)

Send if the value has changed.

Member Data Documentation

◆ pIsWheelAction

bool Dragengine.Gui.Slider.ActionSlide.pIsWheelAction
protected

◆ pSlider

Slider Dragengine.Gui.Slider.ActionSlide.pSlider
protected

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