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

Stepper widget, which has a up/down button interface to allow for increasing/decreasing values of other nearby widgets. More...

#include <hdicoreStepper.h>

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

Public Member Functions

 Stepper ()
 Constructs an empty Stepper object. More...
 
 Stepper (const Stepper &stepper_)
 Constructs a new Stepper object from an existing Stepper object (copy constructor) More...
 
 Stepper (const Point &loc_)
 Constructs a stepper. More...
 
virtual ~Stepper ()
 Stepper destructor. More...
 
virtual Stepperoperator= (const Stepper &rhs_)
 Allows one Stepper object to be assigned from another. More...
 
virtual Stepperclone () const
 Convenience method to clone a Stepper object on the heap. More...
 
virtual Stepperduplicate () const
 Convenience method to duplicate a Stepper object, creating a new and identical UI element to the target (but not belonging to the same containing window) More...
 
virtual Callback *const upClickCallback () const
 Gets the up-click callback for the stepper. More...
 
virtual void setUpClickCallback (const Callback &callback_)
 Sets the up-click callback. More...
 
virtual Callback *const downClickCallback () const
 Gets the down-click callback for the stepper. More...
 
virtual void setDownClickCallback (const Callback &callback_)
 Sets the down-click 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

Stepper widget, which has a up/down button interface to allow for increasing/decreasing values of other nearby widgets.

Constructor & Destructor Documentation

◆ Stepper() [1/3]

hdi::core::Stepper::Stepper ( )

Constructs an empty Stepper object.

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

◆ Stepper() [2/3]

hdi::core::Stepper::Stepper ( const Stepper stepper_)

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

Author
GW
Date
02/2017
Parameters
stepper_Existing Stepper object

◆ Stepper() [3/3]

hdi::core::Stepper::Stepper ( const Point loc_)

Constructs a stepper.

Author
GW
Date
02/2017
Parameters
loc_Position of the stepper, in 1x resolution coordinates

◆ ~Stepper()

virtual hdi::core::Stepper::~Stepper ( )
virtual

Stepper destructor.

Author
GW
Date
02/2017

Member Function Documentation

◆ clone()

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

Convenience method to clone a Stepper object on the heap.

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

Implements hdi::core::Widget.

◆ downClickCallback()

virtual Callback* const hdi::core::Stepper::downClickCallback ( ) const
virtual

Gets the down-click callback for the stepper.

Author
GW
Date
02/2017
Returns
A pointer to the currently registered down-click callback

◆ duplicate()

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

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

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

Implements hdi::core::Widget.

◆ operator=()

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

Allows one Stepper object to be assigned from another.

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

◆ setDownClickCallback()

virtual void hdi::core::Stepper::setDownClickCallback ( const Callback callback_)
virtual

Sets the down-click callback.

Author
GW
Date
02/2017
Parameters
callback_New callback for when the stepper's down-button is clicked

◆ setUpClickCallback()

virtual void hdi::core::Stepper::setUpClickCallback ( const Callback callback_)
virtual

Sets the up-click callback.

Author
GW
Date
02/2017
Parameters
callback_New callback for when the stepper's up-button is clicked

◆ upClickCallback()

virtual Callback* const hdi::core::Stepper::upClickCallback ( ) const
virtual

Gets the up-click callback for the stepper.

Author
GW
Date
02/2017
Returns
A pointer to the currently registered up-click callback