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

Divider class for UI divider lines. More...

#include <hdicoreDivider.h>

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

Public Types

enum  Direction { UnknownDirection = 0, Horizontal = 10, Vertical = 20 }
 Describes the direction of the line in a Divider object.
 
- 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.
 

Public Member Functions

 Divider ()
 Constructs an empty Divider object. More...
 
 Divider (const Divider &div_)
 Constructs a new Divider object from an existing Divider object (copy constructor) More...
 
 Divider (const Point &loc_, const double length_, const Direction dir_=Horizontal)
 Constructs a divider line widget. More...
 
virtual ~Divider ()
 Divider destructor. More...
 
virtual Divideroperator= (const Divider &rhs_)
 Allows one Divider object to be assigned from another. More...
 
virtual Dividerclone () const
 Convenience method to clone a Divider object on the heap. More...
 
virtual Dividerduplicate () const
 Convenience method to duplicate a Divider object, creating a new and identical UI element to the target (but not belonging to the same containing window) More...
 
virtual Type type () const
 Returns DividerType, as dividers are always dividers! More...
 
virtual Direction direction () const
 Gets the direction that the line is going. More...
 
virtual std::string text () const
 Always gets "", as dividers cannot have text. More...
 
virtual void setText (const std::string &)
 Prevents setting the text, as dividers cannot have text. More...
 
virtual bool enabled ()
 Returns true, because dividers are always enabled. More...
 
virtual void setEnabled (const bool enable_)
 Overrides Widget::setEnabled() because dividers are always enabled. 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 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 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

- 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

Divider class for UI divider lines.

Constructor & Destructor Documentation

◆ Divider() [1/3]

hdi::core::Divider::Divider ( )

Constructs an empty Divider object.

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

◆ Divider() [2/3]

hdi::core::Divider::Divider ( const Divider div_)

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

Author
GW
Date
09/2013
Parameters
div_Existing Divider object

◆ Divider() [3/3]

hdi::core::Divider::Divider ( const Point loc_,
const double  length_,
const Direction  dir_ = Horizontal 
)

Constructs a divider line widget.

Author
GW
Date
09/2013
Parameters
loc_Top-left of the divider, in 1x resolution coordinates
length_Length of the divider
dir_Horizontal or vertical line?

◆ ~Divider()

virtual hdi::core::Divider::~Divider ( )
virtual

Divider destructor.

Author
GW
Date
09/2013

Member Function Documentation

◆ clone()

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

Convenience method to clone a Divider object on the heap.

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

Implements hdi::core::Widget.

◆ direction()

virtual Direction hdi::core::Divider::direction ( ) const
virtual

Gets the direction that the line is going.

Author
GW
Date
09/2013
Returns
Vertical for a vertical line, Horizontal otherwise

◆ duplicate()

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

Convenience method to duplicate a Divider 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 Divider object (and new UI element)
Warning
The caller must manage the memory for the returned Divider object.

Implements hdi::core::Widget.

◆ enabled()

virtual bool hdi::core::Divider::enabled ( )
virtual

Returns true, because dividers are always enabled.

Author
GW
Date
09/2013
Returns
true

Reimplemented from hdi::core::Widget.

◆ operator=()

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

Allows one Divider 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 Divider object, but with its value updated to match that of rhs_

◆ setEnabled()

virtual void hdi::core::Divider::setEnabled ( const bool  enable_)
virtual

Overrides Widget::setEnabled() because dividers are always enabled.

Author
GW
Date
09/2013
Parameters
enable_true to enable, false to disable (ignored)

Reimplemented from hdi::core::Widget.

◆ setText()

virtual void hdi::core::Divider::setText ( const std::string &  )
virtual

Prevents setting the text, as dividers cannot have text.

Author
GW
Date
09/2013

Reimplemented from hdi::core::Widget.

◆ text()

virtual std::string hdi::core::Divider::text ( ) const
virtual

Always gets "", as dividers cannot have text.

Author
GW
Date
09/2013
Returns
""

Reimplemented from hdi::core::Widget.

◆ type()

virtual Type hdi::core::Divider::type ( ) const
virtual

Returns DividerType, as dividers are always dividers!

Author
GW
Date
09/2013
Returns
DividerType

Reimplemented from hdi::core::Widget.