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

Box class for UI boxes, which form a thin labeled border around a group of other widgets. More...

#include <hdicoreBox.h>

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

Public Member Functions

 Box ()
 Constructs an empty Box object. More...
 
 Box (const Box &box_)
 Constructs a new Box object from an existing Box object (copy constructor) More...
 
 Box (const Rect &frame_, const std::string &title_="")
 Constructs a box with an optional title. More...
 
virtual ~Box ()
 Box destructor. More...
 
virtual Boxoperator= (const Box &rhs_)
 Allows one Box object to be assigned from another. More...
 
virtual Boxclone () const
 Convenience method to clone a Box object on the heap. More...
 
virtual Boxduplicate () const
 Convenience method to duplicate a Box 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 BoxType, as boxes are always boxes! More...
 
virtual std::string text () const
 Gets the current text value of the box. More...
 
virtual void setText (const std::string &text_)
 Sets the current text value of the box. More...
 
virtual bool enabled ()
 Returns true, because boxes are always enabled. More...
 
virtual void setEnabled (const bool enable_)
 Overrides Widget::setEnabled() because boxes 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

- 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

Box class for UI boxes, which form a thin labeled border around a group of other widgets.

Constructor & Destructor Documentation

◆ Box() [1/3]

hdi::core::Box::Box ( )

Constructs an empty Box object.

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

◆ Box() [2/3]

hdi::core::Box::Box ( const Box box_)

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

Author
GW
Date
09/2013
Parameters
box_Existing Box object

◆ Box() [3/3]

hdi::core::Box::Box ( const Rect frame_,
const std::string &  title_ = "" 
)

Constructs a box with an optional title.

Author
GW
Date
09/2013
Parameters
frame_Position and size of the box, in 1x resolution coordinates
title_Title of the box, as UTF-8

◆ ~Box()

virtual hdi::core::Box::~Box ( )
virtual

Box destructor.

Author
GW
Date
09/2013

Member Function Documentation

◆ clone()

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

Convenience method to clone a Box object on the heap.

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

Implements hdi::core::Widget.

◆ duplicate()

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

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

Implements hdi::core::Widget.

◆ enabled()

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

Returns true, because boxes are always enabled.

Author
GW
Date
09/2013
Returns
true

Reimplemented from hdi::core::Widget.

◆ operator=()

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

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

◆ setEnabled()

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

Overrides Widget::setEnabled() because boxes 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::Box::setText ( const std::string &  text_)
virtual

Sets the current text value of the box.

Author
GW
Date
09/2013
Parameters
text_New text value, as UTF-8

Reimplemented from hdi::core::Widget.

◆ text()

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

Gets the current text value of the box.

Author
GW
Date
09/2013
Returns
The current text value, as UTF-8

Reimplemented from hdi::core::Widget.

◆ type()

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

Returns BoxType, as boxes are always boxes!

Author
GW
Date
09/2013
Returns
BoxType

Reimplemented from hdi::core::Widget.