Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
|
Divider class for UI divider lines. More...
#include <hdicoreDivider.h>
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. | |
Divider (const Divider &div_) | |
Constructs a new Divider object from an existing Divider object (copy constructor) | |
Divider (const Point &loc_, const double length_, const Direction dir_=Horizontal) | |
Constructs a divider line widget. | |
virtual | ~Divider () |
Divider destructor. | |
virtual Divider & | operator= (const Divider &rhs_) |
Allows one Divider object to be assigned from another. | |
virtual Divider * | clone () const |
Convenience method to clone a Divider object on the heap. | |
virtual Divider * | duplicate () 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) | |
virtual Type | type () const |
Returns DividerType, as dividers are always dividers! | |
virtual Direction | direction () const |
Gets the direction that the line is going. | |
virtual std::string | text () const |
Always gets "", as dividers cannot have text. | |
virtual void | setText (const std::string &) |
Prevents setting the text, as dividers cannot have text. | |
virtual bool | enabled () |
Returns true, because dividers are always enabled. | |
virtual void | setEnabled (const bool enable_) |
Overrides Widget::setEnabled() because dividers are always enabled. | |
Public Member Functions inherited from hdi::core::Widget | |
virtual | ~Widget () |
Destructs a Widget. | |
virtual Widget * | clone () const =0 |
Convenience method to clone a Widget object in memory, taking its subclass type into account. | |
virtual Widget * | duplicate () const =0 |
Convenience method to duplicate a Widget object, creating a new and identical UI element to the target (but not belonging to the same containing window) | |
virtual PlatformWidgetPtr | platformWidget () const |
Gets the platform-specific widget, around which the target object is wrapped. | |
virtual bool | isEmpty () const |
Gets whether the target Widget object is empty (constructed with the default ctor) | |
virtual bool | operator== (const Widget &rhs_) const |
Tests whether a given Widget object is the same as another. | |
virtual bool | operator!= (const Widget &rhs_) const |
Tests whether a given Widget object is not the same as another. | |
virtual Type | type () const |
Gets the type of the widget. | |
virtual Window *const | window () const |
Gets the parent window of the widget. | |
virtual Rect | frame () const |
Gets the widget frame. | |
virtual void | setFrame (const Rect &frame_) |
Sets the widget frame. | |
virtual void | offset (const double x_, const double y_) |
Offsets the widget from its current location by the given amounts, in 1x resolution coordinates. | |
virtual std::string | text () const |
Gets the current text value of the widget. | |
virtual void | setText (const std::string &text_) |
Sets the current text value of the widget. | |
virtual bool | enabled () |
Gets whether the widget is enabled. | |
virtual void | setEnabled (const bool enable_) |
Enables or disables the widget. | |
virtual bool | visible () |
Gets whether the widget is visible. | |
virtual void | setVisible (const bool visible_) |
Shows or hides the widget. | |
virtual void | setOrigin (const Point &p_) |
Convenience method to set just the origin of the target widget's frame. | |
virtual void | setSize (const Size &s_) |
Convenience method to set just the size of the target widget's frame. | |
virtual void | setWidth (const double w_) |
Convenience method to set just the width of the target widget's frame. | |
virtual void | setHeight (const double h_) |
Convenience method to set just the height of the target widget's frame. | |
virtual bool | hasFocus () const |
Gets whether the widget currently has focus. | |
virtual void | focus () const |
Forces the widget to have focus, taking it from any other focused widget of the same window. | |
virtual Callback *const | focusCallback () const |
Gets the current focus callback for the widget. | |
virtual void | setFocusCallback (const Callback &callback_) |
Sets the focus callback for the widget. | |
virtual void | blur () const |
Removes focus from the widget. | |
virtual Callback *const | blurCallback () const |
Gets the current blur callback for the widget. | |
virtual void | setBlurCallback (const Callback &callback_) |
Sets the blur callback for the widget. | |
virtual std::string | tooltip () const |
Gets the tool tip string for the widget. | |
virtual void | setTooltip (const std::string &tip_) |
Sets the tool tip string for the widget. | |
virtual void | update () |
Force the widget to update (i.e. cause it to redraw) | |
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. | |
static std::unique_ptr< Widget > | lastClickedWidget () |
Gets the last widget that received a click event (either by the user or programmatically) | |
static std::unique_ptr< Widget > | lastValueChangingWidget () |
Gets the last widget that received a value changing event (either by the user or programmatically) | |
static std::unique_ptr< Widget > | lastValueChangedWidget () |
Gets the last widget that received a value changed event (either by the user or programmatically) | |
static std::unique_ptr< Widget > | lastDropWidget () |
Gets the last widget that received a drag-and-drop drop event (either by the user or programmatically) | |
static std::unique_ptr< Widget > | lastPotentialReorderWidget () |
Gets the last widget that received a potential-reorder event. | |
static std::unique_ptr< Widget > | lastReorderWidget () |
Gets the last widget that received a reorder event. | |
Protected Member Functions inherited from hdi::core::Widget | |
void * | _impl () const |
Internal use only. | |
Widget () | |
Constructs an empty Widget object. | |
Widget (const Widget &w_) | |
Constructs a new Widget object from an existing Widget object (copy constructor) | |
Widget (pui::Widget *&) | |
Internal use only. | |
virtual Widget & | operator= (const Widget &) |
Internal use only. | |
Protected Attributes inherited from hdi::core::Widget | |
void * | _data |
Private implementation data. | |
Divider class for UI divider lines.
hdi::core::Divider::Divider | ( | ) |
Constructs an empty Divider object.
hdi::core::Divider::Divider | ( | const Divider & | div_ | ) |
hdi::core::Divider::Divider | ( | const Point & | loc_, |
const double | length_, | ||
const Direction | dir_ = Horizontal |
||
) |
Constructs a divider line widget.
loc_ | Top-left of the divider, in 1x resolution coordinates |
length_ | Length of the divider |
dir_ | Horizontal or vertical line? |
|
virtual |
Divider destructor.
|
virtual |
Convenience method to clone a Divider object on the heap.
Implements hdi::core::Widget.
|
virtual |
Gets the direction that the line is going.
|
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)
Implements hdi::core::Widget.
|
virtual |
Returns true, because dividers are always enabled.
Reimplemented from hdi::core::Widget.
|
virtual |
Overrides Widget::setEnabled() because dividers are always enabled.
enable_ | true to enable, false to disable (ignored) |
Reimplemented from hdi::core::Widget.
|
virtual |
Prevents setting the text, as dividers cannot have text.
Reimplemented from hdi::core::Widget.
|
virtual |
Always gets "", as dividers cannot have text.
Reimplemented from hdi::core::Widget.
|
virtual |
Returns DividerType, as dividers are always dividers!
Reimplemented from hdi::core::Widget.