openshot-audio  0.1.6
Classes | Public Types | Public Member Functions | Friends | List of all members
Slider Class Reference

#include <juce_Slider.h>

Inheritance diagram for Slider:
SettableTooltipClient TooltipClient ColourSelector::ColourComponentSlider

Classes

class  Listener
 
struct  LookAndFeelMethods
 
class  Pimpl
 
struct  SliderLayout
 

Public Types

enum  SliderStyle {
  LinearHorizontal, LinearVertical, LinearBar, LinearBarVertical,
  Rotary, RotaryHorizontalDrag, RotaryVerticalDrag, RotaryHorizontalVerticalDrag,
  IncDecButtons, TwoValueHorizontal, TwoValueVertical, ThreeValueHorizontal,
  ThreeValueVertical
}
 
enum  TextEntryBoxPosition {
  NoTextBox, TextBoxLeft, TextBoxRight, TextBoxAbove,
  TextBoxBelow
}
 
enum  DragMode { notDragging, absoluteDrag, velocityDrag }
 
enum  IncDecButtonMode { incDecButtonsNotDraggable, incDecButtonsDraggable_AutoDirection, incDecButtonsDraggable_Horizontal, incDecButtonsDraggable_Vertical }
 
enum  ColourIds {
  backgroundColourId = 0x1001200, thumbColourId = 0x1001300, trackColourId = 0x1001310, rotarySliderFillColourId = 0x1001311,
  rotarySliderOutlineColourId = 0x1001312, textBoxTextColourId = 0x1001400, textBoxBackgroundColourId = 0x1001500, textBoxHighlightColourId = 0x1001600,
  textBoxOutlineColourId = 0x1001700
}
 

Public Member Functions

 Slider ()
 
 Slider (const String &componentName)
 
 Slider (SliderStyle style, TextEntryBoxPosition textBoxPosition)
 
 ~Slider ()
 
void setSliderStyle (SliderStyle newStyle)
 
SliderStyle getSliderStyle () const noexcept
 
void setRotaryParameters (float startAngleRadians, float endAngleRadians, bool stopAtEnd)
 
void setMouseDragSensitivity (int distanceForFullScaleDrag)
 
int getMouseDragSensitivity () const noexcept
 
void setVelocityBasedMode (bool isVelocityBased)
 
bool getVelocityBasedMode () const noexcept
 
void setVelocityModeParameters (double sensitivity=1.0, int threshold=1, double offset=0.0, bool userCanPressKeyToSwapMode=true)
 
double getVelocitySensitivity () const noexcept
 
int getVelocityThreshold () const noexcept
 
double getVelocityOffset () const noexcept
 
bool getVelocityModeIsSwappable () const noexcept
 
void setSkewFactor (double factor)
 
void setSkewFactorFromMidPoint (double sliderValueToShowAtMidPoint)
 
double getSkewFactor () const noexcept
 
void setIncDecButtonsMode (IncDecButtonMode mode)
 
void setTextBoxStyle (TextEntryBoxPosition newPosition, bool isReadOnly, int textEntryBoxWidth, int textEntryBoxHeight)
 
TextEntryBoxPosition getTextBoxPosition () const noexcept
 
int getTextBoxWidth () const noexcept
 
int getTextBoxHeight () const noexcept
 
void setTextBoxIsEditable (bool shouldBeEditable)
 
bool isTextBoxEditable () const noexcept
 
void showTextBox ()
 
void hideTextBox (bool discardCurrentEditorContents)
 
void setValue (double newValue, NotificationType notification=sendNotificationAsync)
 
double getValue () const
 
ValuegetValueObject () noexcept
 
void setRange (double newMinimum, double newMaximum, double newInterval=0)
 
double getMaximum () const noexcept
 
double getMinimum () const noexcept
 
double getInterval () const noexcept
 
double getMinValue () const
 
ValuegetMinValueObject () noexcept
 
void setMinValue (double newValue, NotificationType notification=sendNotificationAsync, bool allowNudgingOfOtherValues=false)
 
double getMaxValue () const
 
ValuegetMaxValueObject () noexcept
 
void setMaxValue (double newValue, NotificationType notification=sendNotificationAsync, bool allowNudgingOfOtherValues=false)
 
void setMinAndMaxValues (double newMinValue, double newMaxValue, NotificationType notification=sendNotificationAsync)
 
void addListener (Listener *listener)
 
void removeListener (Listener *listener)
 
void setDoubleClickReturnValue (bool shouldDoubleClickBeEnabled, double valueToSetOnDoubleClick)
 
double getDoubleClickReturnValue () const noexcept
 
bool isDoubleClickReturnEnabled () const noexcept
 
void setChangeNotificationOnlyOnRelease (bool onlyNotifyOnRelease)
 
void setSliderSnapsToMousePosition (bool shouldSnapToMouse)
 
bool getSliderSnapsToMousePosition () const noexcept
 
void setPopupDisplayEnabled (bool isEnabled, Component *parentComponentToUse)
 
ComponentgetCurrentPopupDisplay () const noexcept
 
void setPopupMenuEnabled (bool menuEnabled)
 
void setScrollWheelEnabled (bool enabled)
 
int getThumbBeingDragged () const noexcept
 
virtual void startedDragging ()
 
virtual void stoppedDragging ()
 
virtual void valueChanged ()
 
virtual double getValueFromText (const String &text)
 
virtual String getTextFromValue (double value)
 
void setTextValueSuffix (const String &suffix)
 
String getTextValueSuffix () const
 
int getNumDecimalPlacesToDisplay () const noexcept
 
virtual double proportionOfLengthToValue (double proportion)
 
virtual double valueToProportionOfLength (double value)
 
float getPositionOfValue (double value)
 
virtual double snapValue (double attemptedValue, DragMode dragMode)
 
void updateText ()
 
bool isHorizontal () const noexcept
 
bool isVertical () const noexcept
 
bool isRotary () const noexcept
 
bool isBar () const noexcept
 
void paint (Graphics &) override
 
void resized () override
 
void mouseDown (const MouseEvent &) override
 
void mouseUp (const MouseEvent &) override
 
void mouseDrag (const MouseEvent &) override
 
void mouseDoubleClick (const MouseEvent &) override
 
void mouseWheelMove (const MouseEvent &, const MouseWheelDetails &) override
 
void modifierKeysChanged (const ModifierKeys &) override
 
void lookAndFeelChanged () override
 
void enablementChanged () override
 
void focusOfChildComponentChanged (FocusChangeType) override
 
void colourChanged () override
 
- Public Member Functions inherited from SettableTooltipClient
virtual ~SettableTooltipClient ()
 
virtual void setTooltip (const String &newTooltip)
 
virtual String getTooltip ()
 
- Public Member Functions inherited from TooltipClient
virtual ~TooltipClient ()
 

Friends

class Pimpl
 
struct ContainerDeletePolicy< Pimpl >
 

Additional Inherited Members

- Protected Member Functions inherited from SettableTooltipClient
 SettableTooltipClient ()
 

Detailed Description

A slider control for changing a value.

The slider can be horizontal, vertical, or rotary, and can optionally have a text-box inside it to show an editable display of the current value.

To use it, create a Slider object and use the setSliderStyle() method to set up the type you want. To set up the text-entry box, use setTextBoxStyle().

To define the values that it can be set to, see the setRange() and setValue() methods.

There are also lots of custom tweaks you can do by subclassing and overriding some of the virtual methods, such as changing the scaling, changing the format of the text display, custom ways of limiting the values, etc.

You can register Slider::Listener objects with a slider, and they'll be called when the value changes.

See also
Slider::Listener

Member Enumeration Documentation

A set of colour IDs to use to change the colour of various aspects of the slider.

These constants can be used either via the Component::setColour(), or LookAndFeel::setColour() methods.

See also
Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour
Enumerator
backgroundColourId 

A colour to use to fill the slider's background.

thumbColourId 

The colour to draw the thumb with. It's up to the look and feel class how this is used.

trackColourId 

The colour to draw the groove that the thumb moves along.

rotarySliderFillColourId 

For rotary sliders, this colour fills the outer curve.

rotarySliderOutlineColourId 

For rotary sliders, this colour is used to draw the outer curve's outline.

textBoxTextColourId 

The colour for the text in the text-editor box used for editing the value.

textBoxBackgroundColourId 

The background colour for the text-editor box.

textBoxHighlightColourId 

The text highlight colour for the text-editor box.

textBoxOutlineColourId 

The colour to use for a border around the text-editor box.

Describes the type of mouse-dragging that is happening when a value is being changed.

See also
snapValue
Enumerator
notDragging 

Dragging is not active.

absoluteDrag 

The dragging corresponds directly to the value that is displayed.

velocityDrag 

The dragging value change is relative to the velocity of the mouse mouvement.

Used by setIncDecButtonsMode().

Enumerator
incDecButtonsNotDraggable 
incDecButtonsDraggable_AutoDirection 
incDecButtonsDraggable_Horizontal 
incDecButtonsDraggable_Vertical 

The types of slider available.

See also
setSliderStyle, setRotaryParameters
Enumerator
LinearHorizontal 

A traditional horizontal slider.

LinearVertical 

A traditional vertical slider.

LinearBar 

A horizontal bar slider with the text label drawn on top of it.

LinearBarVertical 
Rotary 

A rotary control that you move by dragging the mouse in a circular motion, like a knob.

See also
setRotaryParameters
RotaryHorizontalDrag 

A rotary control that you move by dragging the mouse left-to-right.

See also
setRotaryParameters
RotaryVerticalDrag 

A rotary control that you move by dragging the mouse up-and-down.

See also
setRotaryParameters
RotaryHorizontalVerticalDrag 

A rotary control that you move by dragging the mouse up-and-down or left-to-right.

See also
setRotaryParameters
IncDecButtons 

A pair of buttons that increment or decrement the slider's value by the increment set in setRange().

TwoValueHorizontal 

A horizontal slider that has two thumbs instead of one, so it can show a minimum and maximum value.

See also
setMinValue, setMaxValue
TwoValueVertical 

A vertical slider that has two thumbs instead of one, so it can show a minimum and maximum value.

See also
setMinValue, setMaxValue
ThreeValueHorizontal 

A horizontal slider that has three thumbs instead of one, so it can show a minimum and maximum value, with the current value being somewhere between them.

See also
setMinValue, setMaxValue
ThreeValueVertical 

A vertical slider that has three thumbs instead of one, so it can show a minimum and maximum value, with the current value being somewhere between them.

See also
setMinValue, setMaxValue

The position of the slider's text-entry box.

See also
setTextBoxStyle
Enumerator
NoTextBox 

Doesn't display a text box.

TextBoxLeft 

Puts the text box to the left of the slider, vertically centred.

TextBoxRight 

Puts the text box to the right of the slider, vertically centred.

TextBoxAbove 

Puts the text box above the slider, horizontally centred.

TextBoxBelow 

Puts the text box below the slider, horizontally centred.

Constructor & Destructor Documentation

Slider::Slider ( )

Creates a slider. When created, you can set up the slider's style and range with setSliderStyle(), setRange(), etc.

Slider::Slider ( const String componentName)
explicit

Creates a slider. When created, you can set up the slider's style and range with setSliderStyle(), setRange(), etc.

Slider::Slider ( SliderStyle  style,
TextEntryBoxPosition  textBoxPosition 
)

Creates a slider with some explicit options.

Slider::~Slider ( )

Destructor.

Member Function Documentation

void Slider::addListener ( Listener listener)

Adds a listener to be called when this slider's value changes.

void Slider::colourChanged ( )
override
void Slider::enablementChanged ( )
override
void Slider::focusOfChildComponentChanged ( FocusChangeType  )
override
Component * Slider::getCurrentPopupDisplay ( ) const
noexcept

If a popup display is enabled and is currently visible, this returns the component that is being shown, or nullptr if none is currently in use.

See also
setPopupDisplayEnabled
double Slider::getDoubleClickReturnValue ( ) const
noexcept

Returns the values last set by setDoubleClickReturnValue() method.

See also
setDoubleClickReturnValue
double Slider::getInterval ( ) const
noexcept

Returns the current step-size for values.

See also
setRange
double Slider::getMaximum ( ) const
noexcept

Returns the current maximum value.

See also
setRange
double Slider::getMaxValue ( ) const

For a slider with two or three thumbs, this returns the higher of its values.

For a two-value slider, the values are controlled with getMinValue() and getMaxValue(). A slider with three values also uses the normal getValue() and setValue() methods to control the middle value.

See also
getMinValue, TwoValueHorizontal, TwoValueVertical, ThreeValueHorizontal, ThreeValueVertical
Value & Slider::getMaxValueObject ( )
noexcept

For a slider with two or three thumbs, this returns the higher of its values. You can use this Value object to connect the slider's position to external values or setters, either by taking a copy of the Value, or by using Value::referTo() to make it point to your own Value object.

See also
Value, getMaxValue, getMinValueObject
double Slider::getMinimum ( ) const
noexcept

Returns the current minimum value.

See also
setRange
double Slider::getMinValue ( ) const

For a slider with two or three thumbs, this returns the lower of its values.

For a two-value slider, the values are controlled with getMinValue() and getMaxValue(). A slider with three values also uses the normal getValue() and setValue() methods to control the middle value.

See also
setMinValue, getMaxValue, TwoValueHorizontal, TwoValueVertical, ThreeValueHorizontal, ThreeValueVertical
Value & Slider::getMinValueObject ( )
noexcept

For a slider with two or three thumbs, this returns the lower of its values. You can use this Value object to connect the slider's position to external values or setters, either by taking a copy of the Value, or by using Value::referTo() to make it point to your own Value object.

See also
Value, getMinValue, getMaxValueObject
int Slider::getMouseDragSensitivity ( ) const
noexcept

Returns the current sensitivity value set by setMouseDragSensitivity().

int Slider::getNumDecimalPlacesToDisplay ( ) const
noexcept

Returns the best number of decimal places to use when displaying this slider's value. It calculates the fewest decimal places needed to represent numbers with the slider's interval setting.

float Slider::getPositionOfValue ( double  value)

Returns the X or Y coordinate of a value along the slider's length.

If the slider is horizontal, this will be the X coordinate of the given value, relative to the left of the slider. If it's vertical, then this will be the Y coordinate, relative to the top of the slider.

If the slider is rotary, this will throw an assertion and return 0. If the value is out-of-range, it will be constrained to the length of the slider.

double Slider::getSkewFactor ( ) const
noexcept

Returns the current skew factor. See setSkewFactor for more info.

See also
setSkewFactor, setSkewFactorFromMidPoint
bool Slider::getSliderSnapsToMousePosition ( ) const
noexcept

Returns true if setSliderSnapsToMousePosition() has been enabled.

Slider::SliderStyle Slider::getSliderStyle ( ) const
noexcept

Returns the slider's current style.

See also
setSliderStyle
int Slider::getTextBoxHeight ( ) const
noexcept

Returns the height used for the text-box.

See also
setTextBoxStyle
Slider::TextEntryBoxPosition Slider::getTextBoxPosition ( ) const
noexcept

Returns the status of the text-box.

See also
setTextBoxStyle
int Slider::getTextBoxWidth ( ) const
noexcept

Returns the width used for the text-box.

See also
setTextBoxStyle
String Slider::getTextFromValue ( double  value)
virtual

Turns the slider's current value into a text string.

Subclasses can override this to customise the formatting of the text-entry box.

The default implementation just turns the value into a string, using a number of decimal places based on the range interval. If a suffix string has been set using setTextValueSuffix(), this will be appended to the text.

See also
getValueFromText

Reimplemented in ColourSelector::ColourComponentSlider.

String Slider::getTextValueSuffix ( ) const

Returns the suffix that was set by setTextValueSuffix().

int Slider::getThumbBeingDragged ( ) const
noexcept

Returns a number to indicate which thumb is currently being dragged by the mouse.

This will return 0 for the main thumb, 1 for the minimum-value thumb, 2 for the maximum-value thumb, or -1 if none is currently down.

double Slider::getValue ( ) const

Returns the slider's current value.

double Slider::getValueFromText ( const String text)
virtual

Subclasses can override this to convert a text string to a value.

When the user enters something into the text-entry box, this method is called to convert it to a value. The default implementation just tries to convert it to a double.

See also
getTextFromValue

Reimplemented in ColourSelector::ColourComponentSlider.

Value & Slider::getValueObject ( )
noexcept

Returns the Value object that represents the slider's current position. You can use this Value object to connect the slider's position to external values or setters, either by taking a copy of the Value, or by using Value::referTo() to make it point to your own Value object.

See also
Value, getMaxValue, getMinValueObject
bool Slider::getVelocityBasedMode ( ) const
noexcept

Returns true if velocity-based mode is active.

See also
setVelocityBasedMode
bool Slider::getVelocityModeIsSwappable ( ) const
noexcept

Returns the velocity user key setting.

See also
setVelocityModeParameters
double Slider::getVelocityOffset ( ) const
noexcept

Returns the velocity offset setting.

See also
setVelocityModeParameters
double Slider::getVelocitySensitivity ( ) const
noexcept

Returns the velocity sensitivity setting.

See also
setVelocityModeParameters
int Slider::getVelocityThreshold ( ) const
noexcept

Returns the velocity threshold setting.

See also
setVelocityModeParameters
void Slider::hideTextBox ( bool  discardCurrentEditorContents)

If the text-box currently has focus and is being edited, this resets it and takes keyboard focus away from it.

Parameters
discardCurrentEditorContentsif true, the slider's value will be left unchanged; if false, the current contents of the text editor will be used to set the slider position before it is hidden.
bool Slider::isBar ( ) const
noexcept

True if the slider is in a linear bar mode.

bool Slider::isDoubleClickReturnEnabled ( ) const
noexcept

Returns true if double-clicking to reset to a default value is enabled.

See also
setDoubleClickReturnValue
bool Slider::isHorizontal ( ) const
noexcept

True if the slider moves horizontally.

bool Slider::isRotary ( ) const
noexcept

True if the slider is in a rotary mode.

bool Slider::isTextBoxEditable ( ) const
noexcept

Returns true if the text-box is read-only.

See also
setTextBoxStyle
bool Slider::isVertical ( ) const
noexcept

True if the slider moves vertically.

void Slider::lookAndFeelChanged ( )
override
void Slider::modifierKeysChanged ( const ModifierKeys modifiers)
override
void Slider::mouseDoubleClick ( const MouseEvent )
override
void Slider::mouseDown ( const MouseEvent e)
override
void Slider::mouseDrag ( const MouseEvent e)
override
void Slider::mouseUp ( const MouseEvent )
override
void Slider::mouseWheelMove ( const MouseEvent e,
const MouseWheelDetails wheel 
)
override
void Slider::paint ( Graphics g)
override
double Slider::proportionOfLengthToValue ( double  proportion)
virtual

Allows a user-defined mapping of distance along the slider to its value.

The default implementation for this performs the skewing operation that can be set up in the setSkewFactor() method. Override it if you need some kind of custom mapping instead, but make sure you also implement the inverse function in valueToProportionOfLength().

Parameters
proportiona value 0 to 1.0, indicating a distance along the slider
Returns
the slider value that is represented by this position
See also
valueToProportionOfLength
void Slider::removeListener ( Listener listener)

Removes a previously-registered listener.

void Slider::resized ( )
override
void Slider::setChangeNotificationOnlyOnRelease ( bool  onlyNotifyOnRelease)

Tells the slider whether to keep sending change messages while the user is dragging the slider.

If set to true, a change message will only be sent when the user has dragged the slider and let go. If set to false (the default), then messages will be continuously sent as they drag it while the mouse button is still held down.

void Slider::setDoubleClickReturnValue ( bool  shouldDoubleClickBeEnabled,
double  valueToSetOnDoubleClick 
)

This lets you choose whether double-clicking moves the slider to a given position.

By default this is turned off, but it's handy if you want a double-click to act as a quick way of resetting a slider. Just pass in the value you want it to go to when double-clicked.

See also
getDoubleClickReturnValue
void Slider::setIncDecButtonsMode ( IncDecButtonMode  mode)

When the style is IncDecButtons, this lets you turn on a mode where the mouse can be dragged on the buttons to drag the values.

By default this is turned off. When enabled, clicking on the buttons still works them as normal, but by holding down the mouse on a button and dragging it a little distance, it flips into a mode where the value can be dragged. The drag direction can either be set explicitly to be vertical or horizontal, or can be set to incDecButtonsDraggable_AutoDirection so that it depends on whether the buttons are side-by-side or above each other.

void Slider::setMaxValue ( double  newValue,
NotificationType  notification = sendNotificationAsync,
bool  allowNudgingOfOtherValues = false 
)

For a slider with two or three thumbs, this sets the lower of its values.

This will trigger a callback to Slider::Listener::sliderValueChanged() for any listeners that are registered, and will synchronously call the valueChanged() method in case subclasses want to handle it.

Parameters
newValuethe new value to set - this will be restricted by the minimum and maximum range, and will be snapped to the nearest interval if one has been set.
notificationcan be one of the NotificationType values, to request a synchronous or asynchronous call to the valueChanged() method of any Slider::Listeners that are registered.
allowNudgingOfOtherValuesif false, this value will be restricted to being above the min value (in a two-value slider) or the mid value (in a three-value slider). If true, then if this value goes beyond those values, it will push them along with it.
See also
getMaxValue, setMinValue, setValue
void Slider::setMinAndMaxValues ( double  newMinValue,
double  newMaxValue,
NotificationType  notification = sendNotificationAsync 
)

For a slider with two or three thumbs, this sets the minimum and maximum thumb positions.

This will trigger a callback to Slider::Listener::sliderValueChanged() for any listeners that are registered, and will synchronously call the valueChanged() method in case subclasses want to handle it.

Parameters
newMinValuethe new minimum value to set - this will be snapped to the nearest interval if one has been set.
newMaxValuethe new minimum value to set - this will be snapped to the nearest interval if one has been set.
notificationcan be one of the NotificationType values, to request a synchronous or asynchronous call to the valueChanged() method of any Slider::Listeners that are registered.
See also
setMaxValue, setMinValue, setValue
void Slider::setMinValue ( double  newValue,
NotificationType  notification = sendNotificationAsync,
bool  allowNudgingOfOtherValues = false 
)

For a slider with two or three thumbs, this sets the lower of its values.

This will trigger a callback to Slider::Listener::sliderValueChanged() for any listeners that are registered, and will synchronously call the valueChanged() method in case subclasses want to handle it.

Parameters
newValuethe new value to set - this will be restricted by the minimum and maximum range, and will be snapped to the nearest interval if one has been set.
notificationcan be one of the NotificationType values, to request a synchronous or asynchronous call to the valueChanged() method of any Slider::Listeners that are registered.
allowNudgingOfOtherValuesif false, this value will be restricted to being below the max value (in a two-value slider) or the mid value (in a three-value slider). If true, then if this value goes beyond those values, it will push them along with it.
See also
getMinValue, setMaxValue, setValue
void Slider::setMouseDragSensitivity ( int  distanceForFullScaleDrag)

Sets the distance the mouse has to move to drag the slider across the full extent of its range.

This only applies when in modes like RotaryHorizontalDrag, where it's using relative mouse movements to adjust the slider.

void Slider::setPopupDisplayEnabled ( bool  isEnabled,
Component parentComponentToUse 
)

If enabled, this gives the slider a pop-up bubble which appears while the slider is being dragged.

This can be handy if your slider doesn't have a text-box, so that users can see the value just when they're changing it.

If you pass a component as the parentComponentToUse parameter, the pop-up bubble will be added as a child of that component when it's needed. If you pass 0, the pop-up will be placed on the desktop instead (note that it's a transparent window, so if you're using an OS that can't do transparent windows you'll have to add it to a parent component instead).

void Slider::setPopupMenuEnabled ( bool  menuEnabled)

If this is set to true, then right-clicking on the slider will pop-up a menu to let the user change the way it works.

By default this is turned off, but when turned on, the menu will include things like velocity sensitivity, and for rotary sliders, whether they use a linear or rotary mouse-drag to move them.

void Slider::setRange ( double  newMinimum,
double  newMaximum,
double  newInterval = 0 
)

Sets the limits that the slider's value can take.

Parameters
newMinimumthe lowest value allowed
newMaximumthe highest value allowed
newIntervalthe steps in which the value is allowed to increase - if this is not zero, the value will always be (newMinimum + (newInterval * an integer)).
void Slider::setRotaryParameters ( float  startAngleRadians,
float  endAngleRadians,
bool  stopAtEnd 
)

Changes the properties of a rotary slider.

Parameters
startAngleRadiansthe angle (in radians, clockwise from the top) at which the slider's minimum value is represented
endAngleRadiansthe angle (in radians, clockwise from the top) at which the slider's maximum value is represented. This must be greater than startAngleRadians
stopAtEnddetermines what happens when a circular drag action rotates beyond the minimum or maximum angle. If true, the value will stop changing until the mouse moves back the way it came; if false, the value will snap back to the value nearest to the mouse. Note that this has no effect if the drag mode is vertical or horizontal.
void Slider::setScrollWheelEnabled ( bool  enabled)

This can be used to stop the mouse scroll-wheel from moving the slider. By default it's enabled.

void Slider::setSkewFactor ( double  factor)

Sets up a skew factor to alter the way values are distributed.

You may want to use a range of values on the slider where more accuracy is required towards one end of the range, so this will logarithmically spread the values across the length of the slider.

If the factor is < 1.0, the lower end of the range will fill more of the slider's length; if the factor is > 1.0, the upper end of the range will be expanded instead. A factor of 1.0 doesn't skew it at all.

To set the skew position by using a mid-point, use the setSkewFactorFromMidPoint() method instead.

See also
getSkewFactor, setSkewFactorFromMidPoint
void Slider::setSkewFactorFromMidPoint ( double  sliderValueToShowAtMidPoint)

Sets up a skew factor to alter the way values are distributed.

This allows you to specify the slider value that should appear in the centre of the slider's visible range.

See also
setSkewFactor, getSkewFactor
void Slider::setSliderSnapsToMousePosition ( bool  shouldSnapToMouse)

This lets you change whether the slider thumb jumps to the mouse position when you click.

By default, this is true. If it's false, then the slider moves with relative motion when you drag it.

This only applies to linear bars, and won't affect two- or three- value sliders.

void Slider::setSliderStyle ( SliderStyle  newStyle)

Changes the type of slider interface being used.

Parameters
newStylethe type of interface
See also
setRotaryParameters, setVelocityBasedMode,
void Slider::setTextBoxIsEditable ( bool  shouldBeEditable)

Makes the text-box editable.

By default this is true, and the user can enter values into the textbox, but it can be turned off if that's not suitable.

See also
setTextBoxStyle, getValueFromText, getTextFromValue
void Slider::setTextBoxStyle ( TextEntryBoxPosition  newPosition,
bool  isReadOnly,
int  textEntryBoxWidth,
int  textEntryBoxHeight 
)

Changes the location and properties of the text-entry box.

Parameters
newPositionwhere it should go (or NoTextBox to not have one at all)
isReadOnlyif true, it's a read-only display
textEntryBoxWidththe width of the text-box in pixels. Make sure this leaves enough room for the slider as well!
textEntryBoxHeightthe height of the text-box in pixels. Make sure this leaves enough room for the slider as well!
See also
setTextBoxIsEditable, getValueFromText, getTextFromValue
void Slider::setTextValueSuffix ( const String suffix)

Sets a suffix to append to the end of the numeric value when it's displayed as a string.

This is used by the default implementation of getTextFromValue(), and is just appended to the numeric value. For more advanced formatting, you can override getTextFromValue() and do something else.

void Slider::setValue ( double  newValue,
NotificationType  notification = sendNotificationAsync 
)

Changes the slider's current value.

This will trigger a callback to Slider::Listener::sliderValueChanged() for any listeners that are registered, and will synchronously call the valueChanged() method in case subclasses want to handle it.

Parameters
newValuethe new value to set - this will be restricted by the minimum and maximum range, and will be snapped to the nearest interval if one has been set
notificationcan be one of the NotificationType values, to request a synchronous or asynchronous call to the valueChanged() method of any Slider::Listeners that are registered.
void Slider::setVelocityBasedMode ( bool  isVelocityBased)

Changes the way the mouse is used when dragging the slider.

If true, this will turn on velocity-sensitive dragging, so that the faster the mouse moves, the bigger the movement to the slider. This helps when making accurate adjustments if the slider's range is quite large.

If false, the slider will just try to snap to wherever the mouse is.

void Slider::setVelocityModeParameters ( double  sensitivity = 1.0,
int  threshold = 1,
double  offset = 0.0,
bool  userCanPressKeyToSwapMode = true 
)

Changes aspects of the scaling used when in velocity-sensitive mode.

These apply when you've used setVelocityBasedMode() to turn on velocity mode, or if you're holding down ctrl.

Parameters
sensitivityhigher values than 1.0 increase the range of acceleration used
thresholdthe minimum number of pixels that the mouse needs to move for it to be treated as a movement
offsetvalues greater than 0.0 increase the minimum speed that will be used when the threshold is reached
userCanPressKeyToSwapModeif true, then the user can hold down the ctrl or command key to toggle velocity-sensitive mode
void Slider::showTextBox ( )

If the text-box is editable, this will give it the focus so that the user can type directly into it. This is basically the effect as the user clicking on it.

double Slider::snapValue ( double  attemptedValue,
DragMode  dragMode 
)
virtual

This can be overridden to allow the slider to snap to user-definable values.

If overridden, it will be called when the user tries to move the slider to a given position, and allows a subclass to sanity-check this value, possibly returning a different value to use instead.

Parameters
attemptedValuethe value the user is trying to enter
dragModeindicates whether the user is dragging with the mouse; notDragging if they are entering the value using the text box or other non-dragging interaction
Returns
the value to use instead
void Slider::startedDragging ( )
virtual

Callback to indicate that the user is about to start dragging the slider.

See also
Slider::Listener::sliderDragStarted
void Slider::stoppedDragging ( )
virtual

Callback to indicate that the user has just stopped dragging the slider.

See also
Slider::Listener::sliderDragEnded
void Slider::updateText ( )

This can be called to force the text box to update its contents. (Not normally needed, as this is done automatically).

void Slider::valueChanged ( )
virtual

Callback to indicate that the user has just moved the slider.

See also
Slider::Listener::sliderValueChanged
double Slider::valueToProportionOfLength ( double  value)
virtual

Allows a user-defined mapping of value to the position of the slider along its length.

The default implementation for this performs the skewing operation that can be set up in the setSkewFactor() method. Override it if you need some kind of custom mapping instead, but make sure you also implement the inverse function in proportionOfLengthToValue().

Parameters
valuea valid slider value, between the range of values specified in setRange()
Returns
a value 0 to 1.0 indicating the distance along the slider that represents this value
See also
proportionOfLengthToValue

Friends And Related Function Documentation

friend struct ContainerDeletePolicy< Pimpl >
friend
friend class Pimpl
friend

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