JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Classes | Public Types | Public Member Functions | List of all members
Slider Class Reference

A slider control for changing a value. More...

Inherits Component, and SettableTooltipClient.

Classes

class  Listener
 A class for receiving callbacks from a Slider. More...
 
struct  LookAndFeelMethods
 This abstract base class is implemented by LookAndFeel classes to provide slider drawing functionality. More...
 

Public Types

enum  SliderStyle {
  LinearHorizontal, LinearVertical, LinearBar, LinearBarVertical,
  Rotary, RotaryHorizontalDrag, RotaryVerticalDrag, RotaryHorizontalVerticalDrag,
  IncDecButtons, TwoValueHorizontal, TwoValueVertical, ThreeValueHorizontal,
  ThreeValueVertical
}
 The types of slider available. More...
 
enum  TextEntryBoxPosition {
  NoTextBox, TextBoxLeft, TextBoxRight, TextBoxAbove,
  TextBoxBelow
}
 The position of the slider's text-entry box. More...
 
enum  DragMode { notDragging, absoluteDrag, velocityDrag }
 Describes the type of mouse-dragging that is happening when a value is being changed. More...
 
enum  IncDecButtonMode { incDecButtonsNotDraggable, incDecButtonsDraggable_AutoDirection, incDecButtonsDraggable_Horizontal, incDecButtonsDraggable_Vertical }
 Used by setIncDecButtonsMode(). More...
 
enum  ColourIds {
  backgroundColourId = 0x1001200, thumbColourId = 0x1001300, trackColourId = 0x1001310, rotarySliderFillColourId = 0x1001311,
  rotarySliderOutlineColourId = 0x1001312, textBoxTextColourId = 0x1001400, textBoxBackgroundColourId = 0x1001500, textBoxHighlightColourId = 0x1001600,
  textBoxOutlineColourId = 0x1001700
}
 A set of colour IDs to use to change the colour of various aspects of the slider. More...
 
- Public Types inherited from Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 Enumeration used by the focusChanged() and focusLost() methods. More...
 

Public Member Functions

 Slider ()
 Creates a slider.
 
 Slider (const String &componentName)
 Creates a slider.
 
 Slider (SliderStyle style, TextEntryBoxPosition textBoxPosition)
 Creates a slider with some explicit options.
 
 ~Slider ()
 Destructor.
 
void setSliderStyle (SliderStyle newStyle)
 Changes the type of slider interface being used.
 
SliderStyle getSliderStyle () const noexcept
 Returns the slider's current style.
 
void setRotaryParameters (float startAngleRadians, float endAngleRadians, bool stopAtEnd)
 Changes the properties of a rotary slider.
 
void setMouseDragSensitivity (int distanceForFullScaleDrag)
 Sets the distance the mouse has to move to drag the slider across the full extent of its range.
 
int getMouseDragSensitivity () const noexcept
 Returns the current sensitivity value set by setMouseDragSensitivity().
 
void setVelocityBasedMode (bool isVelocityBased)
 Changes the way the mouse is used when dragging the slider.
 
bool getVelocityBasedMode () const noexcept
 Returns true if velocity-based mode is active.
 
void 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.
 
double getVelocitySensitivity () const noexcept
 Returns the velocity sensitivity setting.
 
int getVelocityThreshold () const noexcept
 Returns the velocity threshold setting.
 
double getVelocityOffset () const noexcept
 Returns the velocity offset setting.
 
bool getVelocityModeIsSwappable () const noexcept
 Returns the velocity user key setting.
 
void setSkewFactor (double factor)
 Sets up a skew factor to alter the way values are distributed.
 
void setSkewFactorFromMidPoint (double sliderValueToShowAtMidPoint)
 Sets up a skew factor to alter the way values are distributed.
 
double getSkewFactor () const noexcept
 Returns the current skew factor.
 
void 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.
 
void setTextBoxStyle (TextEntryBoxPosition newPosition, bool isReadOnly, int textEntryBoxWidth, int textEntryBoxHeight)
 Changes the location and properties of the text-entry box.
 
TextEntryBoxPosition getTextBoxPosition () const noexcept
 Returns the status of the text-box.
 
int getTextBoxWidth () const noexcept
 Returns the width used for the text-box.
 
int getTextBoxHeight () const noexcept
 Returns the height used for the text-box.
 
void setTextBoxIsEditable (bool shouldBeEditable)
 Makes the text-box editable.
 
bool isTextBoxEditable () const noexcept
 Returns true if the text-box is read-only.
 
void showTextBox ()
 If the text-box is editable, this will give it the focus so that the user can type directly into it.
 
void hideTextBox (bool discardCurrentEditorContents)
 If the text-box currently has focus and is being edited, this resets it and takes keyboard focus away from it.
 
void setValue (double newValue, NotificationType notification=sendNotificationAsync)
 Changes the slider's current value.
 
double getValue () const
 Returns the slider's current value.
 
ValuegetValueObject () noexcept
 Returns the Value object that represents the slider's current position.
 
void setRange (double newMinimum, double newMaximum, double newInterval=0)
 Sets the limits that the slider's value can take.
 
double getMaximum () const noexcept
 Returns the current maximum value.
 
double getMinimum () const noexcept
 Returns the current minimum value.
 
double getInterval () const noexcept
 Returns the current step-size for values.
 
double getMinValue () const
 For a slider with two or three thumbs, this returns the lower of its values.
 
ValuegetMinValueObject () noexcept
 For a slider with two or three thumbs, this returns the lower of its values.
 
void setMinValue (double newValue, NotificationType notification=sendNotificationAsync, bool allowNudgingOfOtherValues=false)
 For a slider with two or three thumbs, this sets the lower of its values.
 
double getMaxValue () const
 For a slider with two or three thumbs, this returns the higher of its values.
 
ValuegetMaxValueObject () noexcept
 For a slider with two or three thumbs, this returns the higher of its values.
 
void setMaxValue (double newValue, NotificationType notification=sendNotificationAsync, bool allowNudgingOfOtherValues=false)
 For a slider with two or three thumbs, this sets the lower of its values.
 
void setMinAndMaxValues (double newMinValue, double newMaxValue, NotificationType notification=sendNotificationAsync)
 For a slider with two or three thumbs, this sets the minimum and maximum thumb positions.
 
void addListener (Listener *listener)
 Adds a listener to be called when this slider's value changes.
 
void removeListener (Listener *listener)
 Removes a previously-registered listener.
 
void setDoubleClickReturnValue (bool isDoubleClickEnabled, double valueToSetOnDoubleClick)
 This lets you choose whether double-clicking moves the slider to a given position.
 
double getDoubleClickReturnValue (bool &isEnabled) const
 Returns the values last set by setDoubleClickReturnValue() method.
 
void setChangeNotificationOnlyOnRelease (bool onlyNotifyOnRelease)
 Tells the slider whether to keep sending change messages while the user is dragging the slider.
 
void setSliderSnapsToMousePosition (bool shouldSnapToMouse)
 This lets you change whether the slider thumb jumps to the mouse position when you click.
 
bool getSliderSnapsToMousePosition () const noexcept
 Returns true if setSliderSnapsToMousePosition() has been enabled.
 
void setPopupDisplayEnabled (bool isEnabled, Component *parentComponentToUse)
 If enabled, this gives the slider a pop-up bubble which appears while the slider is being dragged.
 
ComponentgetCurrentPopupDisplay () 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.
 
void 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.
 
void setScrollWheelEnabled (bool enabled)
 This can be used to stop the mouse scroll-wheel from moving the slider.
 
int getThumbBeingDragged () const noexcept
 Returns a number to indicate which thumb is currently being dragged by the mouse.
 
virtual void startedDragging ()
 Callback to indicate that the user is about to start dragging the slider.
 
virtual void stoppedDragging ()
 Callback to indicate that the user has just stopped dragging the slider.
 
virtual void valueChanged ()
 Callback to indicate that the user has just moved the slider.
 
virtual double getValueFromText (const String &text)
 Subclasses can override this to convert a text string to a value.
 
virtual String getTextFromValue (double value)
 Turns the slider's current value into a text string.
 
void setTextValueSuffix (const String &suffix)
 Sets a suffix to append to the end of the numeric value when it's displayed as a string.
 
String getTextValueSuffix () const
 Returns the suffix that was set by setTextValueSuffix().
 
int getNumDecimalPlacesToDisplay () const noexcept
 Returns the best number of decimal places to use when displaying this slider's value.
 
virtual double proportionOfLengthToValue (double proportion)
 Allows a user-defined mapping of distance along the slider to its value.
 
virtual double valueToProportionOfLength (double value)
 Allows a user-defined mapping of value to the position of the slider along its length.
 
float getPositionOfValue (double value)
 Returns the X or Y coordinate of a value along the slider's length.
 
virtual double snapValue (double attemptedValue, DragMode dragMode)
 This can be overridden to allow the slider to snap to user-definable values.
 
void updateText ()
 This can be called to force the text box to update its contents.
 
bool isHorizontal () const noexcept
 True if the slider moves horizontally.
 
bool isVertical () const noexcept
 True if the slider moves vertically.
 
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 Component
 Component () noexcept
 Creates a component.
 
virtual ~Component ()
 Destructor.
 
 Component (const String &componentName) noexcept
 Creates a component, setting its name at the same time.
 
const StringgetName () const noexcept
 Returns the name of this component.
 
virtual void setName (const String &newName)
 Sets the name of this component.
 
const StringgetComponentID () const noexcept
 Returns the ID string that was set by setComponentID().
 
void setComponentID (const String &newID)
 Sets the component's ID string.
 
virtual void setVisible (bool shouldBeVisible)
 Makes the component visible or invisible.
 
bool isVisible () const noexcept
 Tests whether the component is visible or not.
 
virtual void visibilityChanged ()
 Called when this component's visibility changes.
 
bool isShowing () const
 Tests whether this component and all its parents are visible.
 
virtual void addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
 Makes this component appear as a window on the desktop.
 
void removeFromDesktop ()
 If the component is currently showing on the desktop, this will hide it.
 
bool isOnDesktop () const noexcept
 Returns true if this component is currently showing on the desktop.
 
ComponentPeergetPeer () const
 Returns the heavyweight window that contains this component.
 
virtual void userTriedToCloseWindow ()
 For components on the desktop, this is called if the system wants to close the window.
 
virtual void minimisationStateChanged (bool isNowMinimised)
 Called for a desktop component which has just been minimised or un-minimised.
 
virtual float getDesktopScaleFactor () const
 Returns the default scale factor to use for this component when it is placed on the desktop.
 
void toFront (bool shouldAlsoGainFocus)
 Brings the component to the front of its siblings.
 
void toBack ()
 Changes this component's z-order to be at the back of all its siblings.
 
void toBehind (Component *other)
 Changes this component's z-order so that it's just behind another component.
 
void setAlwaysOnTop (bool shouldStayOnTop)
 Sets whether the component should always be kept at the front of its siblings.
 
bool isAlwaysOnTop () const noexcept
 Returns true if this component is set to always stay in front of its siblings.
 
int getX () const noexcept
 Returns the x coordinate of the component's left edge.
 
int getY () const noexcept
 Returns the y coordinate of the top of this component.
 
int getWidth () const noexcept
 Returns the component's width in pixels.
 
int getHeight () const noexcept
 Returns the component's height in pixels.
 
int getRight () const noexcept
 Returns the x coordinate of the component's right-hand edge.
 
Point< int > getPosition () const noexcept
 Returns the component's top-left position as a Point.
 
int getBottom () const noexcept
 Returns the y coordinate of the bottom edge of this component.
 
const Rectangle< int > & getBounds () const noexcept
 Returns this component's bounding box.
 
Rectangle< int > getLocalBounds () const noexcept
 Returns the component's bounds, relative to its own origin.
 
Rectangle< int > getBoundsInParent () const noexcept
 Returns the area of this component's parent which this component covers.
 
int getScreenX () const
 Returns this component's x coordinate relative the screen's top-left origin.
 
int getScreenY () const
 Returns this component's y coordinate relative the screen's top-left origin.
 
Point< int > getScreenPosition () const
 Returns the position of this component's top-left corner relative to the screen's top-left.
 
Rectangle< int > getScreenBounds () const
 Returns the bounds of this component, relative to the screen's top-left.
 
Point< int > getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space.
 
Point< float > getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space.
 
Rectangle< int > getLocalArea (const Component *sourceComponent, const Rectangle< int > &areaRelativeToSourceComponent) const
 Converts a rectangle to be relative to this component's coordinate space.
 
Point< int > localPointToGlobal (Point< int > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate.
 
Point< float > localPointToGlobal (Point< float > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate.
 
Rectangle< int > localAreaToGlobal (const Rectangle< int > &localArea) const
 Converts a rectangle from this component's coordinate space to a screen coordinate.
 
void setTopLeftPosition (int x, int y)
 Moves the component to a new position.
 
void setTopLeftPosition (Point< int > newTopLeftPosition)
 Moves the component to a new position.
 
void setTopRightPosition (int x, int y)
 Moves the component to a new position.
 
void setSize (int newWidth, int newHeight)
 Changes the size of the component.
 
void setBounds (int x, int y, int width, int height)
 Changes the component's position and size.
 
void setBounds (const Rectangle< int > &newBounds)
 Changes the component's position and size.
 
void setBounds (const RelativeRectangle &newBounds)
 Changes the component's position and size.
 
void setBounds (const String &newBoundsExpression)
 Sets the component's bounds with an expression.
 
void setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
 Changes the component's position and size in terms of fractions of its parent's size.
 
void setBoundsInset (const BorderSize< int > &borders)
 Changes the component's position and size based on the amount of space to leave around it.
 
void setBoundsToFit (int x, int y, int width, int height, Justification justification, bool onlyReduceInSize)
 Positions the component within a given rectangle, keeping its proportions unchanged.
 
void setCentrePosition (int x, int y)
 Changes the position of the component's centre.
 
void setCentreRelative (float x, float y)
 Changes the position of the component's centre.
 
void centreWithSize (int width, int height)
 Changes the component's size and centres it within its parent.
 
void setTransform (const AffineTransform &transform)
 Sets a transform matrix to be applied to this component.
 
AffineTransform getTransform () const
 Returns the transform that is currently being applied to this component.
 
bool isTransformed () const noexcept
 Returns true if a non-identity transform is being applied to this component.
 
int proportionOfWidth (float proportion) const noexcept
 Returns a proportion of the component's width.
 
int proportionOfHeight (float proportion) const noexcept
 Returns a proportion of the component's height.
 
int getParentWidth () const noexcept
 Returns the width of the component's parent.
 
int getParentHeight () const noexcept
 Returns the height of the component's parent.
 
Rectangle< int > getParentMonitorArea () const
 Returns the screen coordinates of the monitor that contains this component.
 
int getNumChildComponents () const noexcept
 Returns the number of child components that this component contains.
 
ComponentgetChildComponent (int index) const noexcept
 Returns one of this component's child components, by it index.
 
int getIndexOfChildComponent (const Component *child) const noexcept
 Returns the index of this component in the list of child components.
 
ComponentfindChildWithID (StringRef componentID) const noexcept
 Looks for a child component with the specified ID.
 
void addChildComponent (Component *child, int zOrder=-1)
 Adds a child component to this one.
 
void addChildComponent (Component &child, int zOrder=-1)
 Adds a child component to this one.
 
void addAndMakeVisible (Component *child, int zOrder=-1)
 Adds a child component to this one, and also makes the child visible if it isn't already.
 
void addAndMakeVisible (Component &child, int zOrder=-1)
 Adds a child component to this one, and also makes the child visible if it isn't already.
 
void addChildAndSetID (Component *child, const String &componentID)
 Adds a child component to this one, makes it visible, and sets its component ID.
 
void removeChildComponent (Component *childToRemove)
 Removes one of this component's child-components.
 
ComponentremoveChildComponent (int childIndexToRemove)
 Removes one of this component's child-components by index.
 
void removeAllChildren ()
 Removes all this component's children.
 
void deleteAllChildren ()
 Removes all this component's children, and deletes them.
 
ComponentgetParentComponent () const noexcept
 Returns the component which this component is inside.
 
template<class TargetClass >
TargetClass * findParentComponentOfClass () const
 Searches the parent components for a component of a specified class.
 
ComponentgetTopLevelComponent () const noexcept
 Returns the highest-level component which contains this one or its parents.
 
bool isParentOf (const Component *possibleChild) const noexcept
 Checks whether a component is anywhere inside this component or its children.
 
virtual void parentHierarchyChanged ()
 Called to indicate that the component's parents have changed.
 
virtual void childrenChanged ()
 Subclasses can use this callback to be told when children are added or removed, or when their z-order changes.
 
virtual bool hitTest (int x, int y)
 Tests whether a given point inside the component.
 
void setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
 Changes the default return value for the hitTest() method.
 
void getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
 Retrieves the current state of the mouse-click interception flags.
 
bool contains (Point< int > localPoint)
 Returns true if a given point lies within this component or one of its children.
 
bool reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
 Returns true if a given point lies in this component, taking any overlapping siblings into account.
 
ComponentgetComponentAt (int x, int y)
 Returns the component at a certain point within this one.
 
ComponentgetComponentAt (Point< int > position)
 Returns the component at a certain point within this one.
 
void repaint ()
 Marks the whole component as needing to be redrawn.
 
void repaint (int x, int y, int width, int height)
 Marks a subsection of this component as needing to be redrawn.
 
void repaint (const Rectangle< int > &area)
 Marks a subsection of this component as needing to be redrawn.
 
void setBufferedToImage (bool shouldBeBuffered)
 Makes the component use an internal buffer to optimise its redrawing.
 
Image createComponentSnapshot (const Rectangle< int > &areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
 Generates a snapshot of part of this component.
 
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
 Draws this component and all its subcomponents onto the specified graphics context.
 
void setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
 This allows you to indicate that this component doesn't require its graphics context to be clipped when it is being painted.
 
void setComponentEffect (ImageEffectFilter *newEffect)
 Adds an effect filter to alter the component's appearance.
 
ImageEffectFiltergetComponentEffect () const noexcept
 Returns the current component effect.
 
LookAndFeelgetLookAndFeel () const noexcept
 Finds the appropriate look-and-feel to use for this component.
 
void setLookAndFeel (LookAndFeel *newLookAndFeel)
 Sets the look and feel to use for this component.
 
void sendLookAndFeelChange ()
 Calls the lookAndFeelChanged() method in this component and all its children.
 
void setOpaque (bool shouldBeOpaque)
 Indicates whether any parts of the component might be transparent.
 
bool isOpaque () const noexcept
 Returns true if no parts of this component are transparent.
 
void setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
 Indicates whether the component should be brought to the front when clicked.
 
bool isBroughtToFrontOnMouseClick () const noexcept
 Indicates whether the component should be brought to the front when clicked-on.
 
void setWantsKeyboardFocus (bool wantsFocus) noexcept
 Sets a flag to indicate whether this component needs keyboard focus or not.
 
bool getWantsKeyboardFocus () const noexcept
 Returns true if the component is interested in getting keyboard focus.
 
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
 Chooses whether a click on this component automatically grabs the focus.
 
bool getMouseClickGrabsKeyboardFocus () const noexcept
 Returns the last value set with setMouseClickGrabsKeyboardFocus().
 
void grabKeyboardFocus ()
 Tries to give keyboard focus to this component.
 
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
 Returns true if this component currently has the keyboard focus.
 
void moveKeyboardFocusToSibling (bool moveToNext)
 Tries to move the keyboard focus to one of this component's siblings.
 
virtual KeyboardFocusTraversercreateFocusTraverser ()
 Creates a KeyboardFocusTraverser object to use to determine the logic by which focus should be passed from this component.
 
int getExplicitFocusOrder () const
 Returns the focus order of this component, if one has been specified.
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 Sets the index used in determining the order in which focusable components should be traversed.
 
void setFocusContainer (bool shouldBeFocusContainer) noexcept
 Indicates whether this component is a parent for components that can have their focus traversed.
 
bool isFocusContainer () const noexcept
 Returns true if this component has been marked as a focus container.
 
bool isEnabled () const noexcept
 Returns true if the component (and all its parents) are enabled.
 
void setEnabled (bool shouldBeEnabled)
 Enables or disables this component.
 
void setAlpha (float newAlpha)
 Changes the transparency of this component.
 
float getAlpha () const
 Returns the component's current transparancy level.
 
void setMouseCursor (const MouseCursor &cursorType)
 Changes the mouse cursor shape to use when the mouse is over this component.
 
virtual MouseCursor getMouseCursor ()
 Returns the mouse cursor shape to use when the mouse is over this component.
 
void updateMouseCursor () const
 Forces the current mouse cursor to be updated.
 
virtual void paintOverChildren (Graphics &g)
 Components can override this method to draw over the top of their children.
 
virtual void mouseMove (const MouseEvent &event) override
 Called when the mouse moves inside a component.
 
virtual void mouseEnter (const MouseEvent &event) override
 Called when the mouse first enters a component.
 
virtual void mouseExit (const MouseEvent &event) override
 Called when the mouse moves out of a component.
 
virtual void mouseMagnify (const MouseEvent &event, float scaleFactor)
 Called when a pinch-to-zoom mouse-gesture is used.
 
void setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
 Causes automatic repaints when the mouse enters or exits this component.
 
void addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
 Registers a listener to be told when mouse events occur in this component.
 
void removeMouseListener (MouseListener *listenerToRemove)
 Deregisters a mouse listener.
 
void addKeyListener (KeyListener *newListener)
 Adds a listener that wants to hear about keypresses that this component receives.
 
void removeKeyListener (KeyListener *listenerToRemove)
 Removes a previously-registered key listener.
 
virtual bool keyPressed (const KeyPress &key)
 Called when a key is pressed.
 
virtual bool keyStateChanged (bool isKeyDown)
 Called when a key is pressed or released.
 
virtual void focusGained (FocusChangeType cause)
 Called to indicate that this component has just acquired the keyboard focus.
 
virtual void focusLost (FocusChangeType cause)
 Called to indicate that this component has just lost the keyboard focus.
 
bool isMouseOver (bool includeChildren=false) const
 Returns true if the mouse is currently over this component.
 
bool isMouseButtonDown () const
 Returns true if the mouse button is currently held down in this component.
 
bool isMouseOverOrDragging () const
 True if the mouse is over this component, or if it's being dragged in this component.
 
Point< int > getMouseXYRelative () const
 Returns the mouse's current position, relative to this component.
 
virtual void moved ()
 Called when this component's position has been changed.
 
virtual void childBoundsChanged (Component *child)
 Called when one of this component's children is moved or resized.
 
virtual void parentSizeChanged ()
 Called when this component's immediate parent has been resized.
 
virtual void broughtToFront ()
 Called when this component has been moved to the front of its siblings.
 
void addComponentListener (ComponentListener *newListener)
 Adds a listener to be told about changes to the component hierarchy or position.
 
void removeComponentListener (ComponentListener *listenerToRemove)
 Removes a component listener.
 
void postCommandMessage (int commandId)
 Dispatches a numbered message to this component.
 
virtual void handleCommandMessage (int commandId)
 Called to handle a command that was sent by postCommandMessage().
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 Runs a component modally, waiting until the loop terminates.
 
void exitModalState (int returnValue)
 Ends a component's modal state.
 
bool isCurrentlyModal () const noexcept
 Returns true if this component is the modal one.
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 Checks whether there's a modal component somewhere that's stopping this one from receiving messages.
 
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
 When a component is modal, this callback allows it to choose which other components can still receive events.
 
virtual void inputAttemptWhenModal ()
 Called when the user tries to click on a component that is blocked by another modal component.
 
NamedValueSetgetProperties () noexcept
 Returns the set of properties that belong to this component.
 
const NamedValueSetgetProperties () const noexcept
 Returns the set of properties that belong to this component.
 
Colour findColour (int colourId, bool inheritFromParent=false) const
 Looks for a colour that has been registered with the given colour ID number.
 
void setColour (int colourId, Colour newColour)
 Registers a colour to be used for a particular purpose.
 
void removeColour (int colourId)
 If a colour has been set with setColour(), this will remove it.
 
bool isColourSpecified (int colourId) const
 Returns true if the specified colour ID has been explicitly set for this component using the setColour() method.
 
void copyAllExplicitColoursTo (Component &target) const
 This looks for any colours that have been specified for this component, and copies them to the specified target component.
 
virtual MarkerListgetMarkers (bool xAxis)
 Components can implement this method to provide a MarkerList.
 
void * getWindowHandle () const
 Returns the underlying native window handle for this component.
 
PositionergetPositioner () const noexcept
 Returns the Positioner object that has been set for this component.
 
void setPositioner (Positioner *newPositioner)
 Sets a new Positioner object for this component.
 
void setCachedComponentImage (CachedComponentImage *newCachedImage)
 Gives the component a CachedComponentImage that should be used to buffer its painting.
 
CachedComponentImagegetCachedComponentImage () const noexcept
 Returns the object that was set by setCachedComponentImage().
 
 JUCE_DEPRECATED (Point< int > relativePositionToGlobal(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > globalPositionToRelative(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > relativePositionToOtherComponent(const Component *, Point< int >) const)
 
- Public Member Functions inherited from MouseListener
virtual ~MouseListener ()
 Destructor.
 
- Public Member Functions inherited from SettableTooltipClient
virtual ~SettableTooltipClient ()
 Destructor.
 
virtual void setTooltip (const String &newTooltip)
 Assigns a new tooltip to this object.
 
virtual String getTooltip ()
 Returns the tooltip assigned to this object.
 
- Public Member Functions inherited from TooltipClient
virtual ~TooltipClient ()
 Destructor.
 

Additional Inherited Members

- Static Public Member Functions inherited from Component
static Component *JUCE_CALLTYPE getCurrentlyFocusedComponent () noexcept
 Returns the component that currently has the keyboard focus.
 
static void JUCE_CALLTYPE unfocusAllComponents ()
 If any component has keyboard focus, this will defocus it.
 
static void JUCE_CALLTYPE beginDragAutoRepeat (int millisecondsBetweenCallbacks)
 Ensures that a non-stop stream of mouse-drag events will be sent during the current mouse-drag operation.
 
static bool JUCE_CALLTYPE isMouseButtonDownAnywhere () noexcept
 Returns true if a mouse button is currently down.
 
static int JUCE_CALLTYPE getNumCurrentlyModalComponents () noexcept
 Returns the number of components that are currently in a modal state.
 
static Component *JUCE_CALLTYPE getCurrentlyModalComponent (int index=0) noexcept
 Returns one of the components that are currently modal.
 
- 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

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.

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 

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.

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::setSliderStyle ( SliderStyle  newStyle)

Changes the type of slider interface being used.

Parameters
newStylethe type of interface
See Also
setRotaryParameters, setVelocityBasedMode,
SliderStyle Slider::getSliderStyle ( ) const
noexcept

Returns the slider's current style.

See Also
setSliderStyle
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::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.

int Slider::getMouseDragSensitivity ( ) const
noexcept

Returns the current sensitivity value set by setMouseDragSensitivity().

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.

bool Slider::getVelocityBasedMode ( ) const
noexcept

Returns true if velocity-based mode is active.

See Also
setVelocityBasedMode
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
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
double Slider::getVelocityOffset ( ) const
noexcept

Returns the velocity offset setting.

See Also
setVelocityModeParameters
bool Slider::getVelocityModeIsSwappable ( ) const
noexcept

Returns the velocity user key setting.

See Also
setVelocityModeParameters
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
double Slider::getSkewFactor ( ) const
noexcept

Returns the current skew factor.

See setSkewFactor for more info.

See Also
setSkewFactor, setSkewFactorFromMidPoint
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::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
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
int Slider::getTextBoxHeight ( ) const
noexcept

Returns the height used for the text-box.

See Also
setTextBoxStyle
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
bool Slider::isTextBoxEditable ( ) const
noexcept

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

See Also
setTextBoxStyle
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.

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.
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.
double Slider::getValue ( ) const

Returns the slider's current value.

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
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)).
double Slider::getMaximum ( ) const
noexcept

Returns the current maximum value.

See Also
setRange
double Slider::getMinimum ( ) const
noexcept

Returns the current minimum value.

See Also
setRange
double Slider::getInterval ( ) const
noexcept

Returns the current step-size for values.

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
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
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
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::addListener ( Listener listener)

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

void Slider::removeListener ( Listener listener)

Removes a previously-registered listener.

void Slider::setDoubleClickReturnValue ( bool  isDoubleClickEnabled,
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
double Slider::getDoubleClickReturnValue ( bool &  isEnabled) const

Returns the values last set by setDoubleClickReturnValue() method.

Sets isEnabled to true if double-click is enabled, and returns the value that was set.

See Also
setDoubleClickReturnValue
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::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.

bool Slider::getSliderSnapsToMousePosition ( ) const
noexcept

Returns true if setSliderSnapsToMousePosition() has been enabled.

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).

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
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::setScrollWheelEnabled ( bool  enabled)

This can be used to stop the mouse scroll-wheel from moving the slider.

By default it's enabled.

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.

virtual void Slider::startedDragging ( )
virtual

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

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

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

See Also
Slider::Listener::sliderDragEnded
virtual void Slider::valueChanged ( )
virtual

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

See Also
Slider::Listener::sliderValueChanged
virtual 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
virtual 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
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.

String Slider::getTextValueSuffix ( ) const

Returns the suffix that was set by setTextValueSuffix().

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.

virtual 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
virtual 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
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.

virtual 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::updateText ( )

This can be called to force the text box to update its contents.

(Not normally needed, as this is done automatically).

bool Slider::isHorizontal ( ) const
noexcept

True if the slider moves horizontally.

bool Slider::isVertical ( ) const
noexcept

True if the slider moves vertically.

void Slider::paint ( Graphics )
overridevirtual

Reimplemented from Component.

void Slider::resized ( )
overridevirtual

Reimplemented from Component.

void Slider::mouseDown ( const MouseEvent )
overridevirtual

Reimplemented from Component.

void Slider::mouseUp ( const MouseEvent )
overridevirtual

Reimplemented from Component.

void Slider::mouseDrag ( const MouseEvent )
overridevirtual

Reimplemented from Component.

void Slider::mouseDoubleClick ( const MouseEvent )
overridevirtual

Reimplemented from Component.

void Slider::mouseWheelMove ( const MouseEvent ,
const MouseWheelDetails  
)
overridevirtual

Reimplemented from Component.

void Slider::modifierKeysChanged ( const ModifierKeys )
overridevirtual

Reimplemented from Component.

void Slider::lookAndFeelChanged ( )
overridevirtual

Reimplemented from Component.

void Slider::enablementChanged ( )
overridevirtual

Reimplemented from Component.

void Slider::focusOfChildComponentChanged ( FocusChangeType  )
overridevirtual

Reimplemented from Component.

void Slider::colourChanged ( )
overridevirtual

Reimplemented from Component.


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