Hot Door CORE  0.7.1
Adobe® Illustrator® Plug-in Library
Public Member Functions | List of all members
hdi::core::Slider Class Reference

Slider widget, which has a sliding interface to allow for arbitrary value selections from 0.0 to 1.0. More...

#include <hdicoreSlider.h>

Inheritance diagram for hdi::core::Slider:
Inheritance graph
[legend]
Collaboration diagram for hdi::core::Slider:
Collaboration graph
[legend]

Public Member Functions

 Slider ()
 Constructs an empty Slider object. More...
 
 Slider (const Slider &slider_)
 Constructs a new Slider object from an existing Slider object (copy constructor) More...
 
 Slider (const Point &loc_, const double value_, const double width_)
 Constructs a slider. More...
 
virtual ~Slider ()
 Slider destructor. More...
 
virtual Slideroperator= (const Slider &rhs_)
 Allows one Slider object to be assigned from another. More...
 
virtual Sliderclone () const
 Convenience method to clone a Slider object on the heap. More...
 
virtual Sliderduplicate () const
 Convenience method to duplicate a Slider object, creating a new and identical UI element to the target (but not belonging to the same containing window) More...
 
virtual double value () const
 Gets the current value of the slider. More...
 
virtual void setValue (const double value_)
 Sets the current value of the slider. More...
 
virtual void valueChanging ()
 Simulates the value of the slider changing. More...
 
virtual Callback *const valueChangingCallback () const
 Gets the value changing callback for the slider. More...
 
virtual void setValueChangingCallback (const Callback &callback_)
 Sets the value changing callback. More...
 
- Public Member Functions inherited from hdi::core::Widget
virtual ~Widget ()
 Destructs a Widget. More...
 
virtual PlatformWidgetPtr platformWidget () const
 Gets the platform-specific widget, around which the target object is wrapped. More...
 
virtual bool isEmpty () const
 Gets whether the target Widget object is empty (constructed with the default ctor) More...
 
virtual bool operator== (const Widget &rhs_) const
 Tests whether a given Widget object is the same as another. More...
 
virtual bool operator!= (const Widget &rhs_) const
 Tests whether a given Widget object is not the same as another. More...
 
virtual Type type () const
 Gets the type of the widget. More...
 
virtual Window *const window () const
 Gets the parent window of the widget. More...
 
virtual Rect frame () const
 Gets the widget frame. More...
 
virtual void setFrame (const Rect &frame_)
 Sets the widget frame. More...
 
virtual void offset (const double x_, const double y_)
 Offsets the widget from its current location by the given amounts, in 1x resolution coordinates. More...
 
virtual std::string text () const
 Gets the current text value of the widget. More...
 
virtual void setText (const std::string &text_)
 Sets the current text value of the widget. More...
 
virtual bool enabled ()
 Gets whether the widget is enabled. More...
 
virtual void setEnabled (const bool enable_)
 Enables or disables the widget. More...
 
virtual bool visible ()
 Gets whether the widget is visible. More...
 
virtual void setVisible (const bool visible_)
 Shows or hides the widget. More...
 
virtual void setOrigin (const Point &p_)
 Convenience method to set just the origin of the target widget's frame. More...
 
virtual void setSize (const Size &s_)
 Convenience method to set just the size of the target widget's frame. More...
 
virtual void setWidth (const double w_)
 Convenience method to set just the width of the target widget's frame. More...
 
virtual void setHeight (const double h_)
 Convenience method to set just the height of the target widget's frame. More...
 
virtual bool hasFocus () const
 Gets whether the widget currently has focus. More...
 
virtual void focus () const
 Forces the widget to have focus, taking it from any other focused widget of the same window. More...
 
virtual void blur () const
 Removes focus from the widget. More...
 
virtual std::string tooltip () const
 Gets the tool tip string for the widget. More...
 
virtual void setTooltip (const std::string &tip_)
 Sets the tool tip string for the widget. More...
 
virtual void update ()
 Force the widget to update (i.e. cause it to redraw) More...
 

Additional Inherited Members

- Public Types inherited from hdi::core::Widget
enum  Type {
  UnknownType = 0, BoxType = 10, ButtonType = 20, CheckboxType = 30,
  ColumnViewType = 40, ComboBoxType = 50, ColorWellType = 60, CustomType = 70,
  DividerType = 80, HierarchicalColumnViewType = 85, HierarchicalViewType = 90, LabelType = 100,
  ListViewType = 110, PopupMenuType = 120, RadioButtonType = 130, SliderType = 140,
  StepperType = 150, TextFieldType = 160, TextViewType = 170, WebViewType = 180
}
 Supported widget types.
 
- Static Public Member Functions inherited from hdi::core::Widget
static bool isCoreWidget (const PlatformWidgetPtr widget_)
 Gets whether the given platform widget is a hdi_core widget. More...
 
static std::auto_ptr< WidgetlastClickedWidget ()
 Gets the last widget that received a click event (either by the user or programmatically) More...
 
static std::auto_ptr< WidgetlastValueChangingWidget ()
 Gets the last widget that received a value changing event (either by the user or programmatically) More...
 
static std::auto_ptr< WidgetlastValueChangedWidget ()
 Gets the last widget that received a value changed event (either by the user or programmatically) More...
 
static bool forceIdeographicFontSize (bool &larger__)
 Gets whether widgets should use an ideographically appropriate font size for widget text on Windows (whether or not the Illustrator locale dictates one should be used) More...
 
static void setForceIdeographicFontSize (const bool force_, const bool larger_)
 Sets whether widgets should use an ideographically appropriate font size for widget text on Windows (whether or not the Illustrator locale dictates one should be used) More...
 
- Protected Member Functions inherited from hdi::core::Widget
void * _impl () const
 Internal use only. More...
 
 Widget ()
 Constructs an empty Widget object. More...
 
 Widget (const Widget &w_)
 Constructs a new Widget object from an existing Widget object (copy constructor) More...
 
 Widget (plugin::Widget *&)
 Internal use only. More...
 
virtual Widgetoperator= (const Widget &)
 Internal use only. More...
 
- Protected Attributes inherited from hdi::core::Widget
void * _data
 Private implementation data.
 

Detailed Description

Slider widget, which has a sliding interface to allow for arbitrary value selections from 0.0 to 1.0.

Constructor & Destructor Documentation

◆ Slider() [1/3]

hdi::core::Slider::Slider ( )

Constructs an empty Slider object.

Author
GW
Date
09/2013
Note
To test if a Slider object is empty, call isEmpty() on it
Empty Slider objects do not relate to any actual UI widget; they are designed to be "receivers" of some other Slider object via the overloaded assignment operator. Empty Slider objects are useless until such time (though it is safe to call any of their methods).

◆ Slider() [2/3]

hdi::core::Slider::Slider ( const Slider slider_)

Constructs a new Slider object from an existing Slider object (copy constructor)

Author
GW
Date
09/2013
Parameters
slider_Existing Slider object

◆ Slider() [3/3]

hdi::core::Slider::Slider ( const Point loc_,
const double  value_,
const double  width_ 
)

Constructs a slider.

Author
GW
Date
09/2013
Parameters
loc_Position of the slider, in 1x resolution coordinates
value_Initial value of the Slider in the range [0.0, 1.0]
width_Width of the slider, at 1x resolution

◆ ~Slider()

virtual hdi::core::Slider::~Slider ( )
virtual

Slider destructor.

Author
GW
Date
09/2013

Member Function Documentation

◆ clone()

virtual Slider* hdi::core::Slider::clone ( ) const
virtual

Convenience method to clone a Slider object on the heap.

Author
GW
Date
10/2013
Returns
A pointer to the new Slider object
Note
If you subclass Slider, you MUST overload this method yourself! If you don't and/or your clone() method does not return an instance of your Slider subclass, you will experience "object slicing" when adding the widget to a window.
Warning
The caller must manage the memory for the returned Slider object.

Implements hdi::core::Widget.

◆ duplicate()

virtual Slider* hdi::core::Slider::duplicate ( ) const
virtual

Convenience method to duplicate a Slider object, creating a new and identical UI element to the target (but not belonging to the same containing window)

Author
GW
Date
11/2013
Returns
A pointer to the new Slider object (and new UI element)
Warning
The caller must manage the memory for the returned Slider object.

Implements hdi::core::Widget.

◆ operator=()

virtual Slider& hdi::core::Slider::operator= ( const Slider rhs_)
virtual

Allows one Slider object to be assigned from another.

Author
GW
Date
10/2013
Parameters
rhs_Righthand side of the = operator; the object to copy values from
Returns
The target Slider object, but with its value updated to match that of rhs_

◆ setValue()

virtual void hdi::core::Slider::setValue ( const double  value_)
virtual

Sets the current value of the slider.

Author
GW
Date
09/2013
Parameters
value_New slider value in the range [0.0, 1.0]
Note
The provided value will be forced within the range [0.0, 1.0]

◆ setValueChangingCallback()

virtual void hdi::core::Slider::setValueChangingCallback ( const Callback callback_)
virtual

Sets the value changing callback.

Author
GW
Date
09/2013
Parameters
callback_New callback for when the slider's value is changing

◆ value()

virtual double hdi::core::Slider::value ( ) const
virtual

Gets the current value of the slider.

Author
GW
Date
09/2013
Returns
The current value of the target Slider object, in range [0.0, 1.0]

◆ valueChanging()

virtual void hdi::core::Slider::valueChanging ( )
virtual

Simulates the value of the slider changing.

Author
GW
Date
09/2013

◆ valueChangingCallback()

virtual Callback* const hdi::core::Slider::valueChangingCallback ( ) const
virtual

Gets the value changing callback for the slider.

Author
GW
Date
09/2013
Returns
A pointer to the currently registered value changing callback