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

Class for color well widgets, which form a clickable square area that represents an Illustrator art color. More...

#include <hdicoreColorWell.h>

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

Public Member Functions

 ColorWell ()
 Constructs an empty ColorWell object. More...
 
 ColorWell (const ColorWell &colorwell_)
 Constructs a new ColorWell object from an existing ColorWell object (copy constructor) More...
 
 ColorWell (const Rect &frame_, const ArtColor &color_)
 Constructs a color well. More...
 
virtual ~ColorWell ()
 ColorWell destructor. More...
 
virtual ColorWelloperator= (const ColorWell &rhs_)
 Allows one ColorWell object to be assigned from another. More...
 
virtual ColorWellclone () const
 Convenience method to clone a ColorWell object on the heap. More...
 
virtual ColorWellduplicate () const
 Convenience method to duplicate a ColorWell object, creating a new and identical UI element to the target (but not belonging to the same containing window) More...
 
virtual ArtColor currentColor () const
 Gets the current value of the color well. More...
 
virtual void setCurrentColor (const ArtColor &color_)
 Sets the current value of the color well. More...
 
virtual void valueChanged ()
 Simulates the color well having its value changed. More...
 
virtual Callback *const valueChangedCallback () const
 Gets the value changed callback for the color well. More...
 
virtual void setValueChangedCallback (const Callback &callback_)
 Sets the value changed 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

Class for color well widgets, which form a clickable square area that represents an Illustrator art color.

Constructor & Destructor Documentation

◆ ColorWell() [1/3]

hdi::core::ColorWell::ColorWell ( )

Constructs an empty ColorWell object.

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

◆ ColorWell() [2/3]

hdi::core::ColorWell::ColorWell ( const ColorWell colorwell_)

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

Author
GW
Date
09/2013
Parameters
colorwell_Existing ColorWell object

◆ ColorWell() [3/3]

hdi::core::ColorWell::ColorWell ( const Rect frame_,
const ArtColor color_ 
)

Constructs a color well.

Author
GW
Date
09/2013
Parameters
frame_Dimensions and top-left location of the color well, in 1x resolution coordinates
color_Initial value of the color well
Note
The type of color with which a ColorWell is "seeded" (the color it has before the color picker is shown) will affect the type of color that is reported by the currentColor() method (e.g. in a value-changed callback). It is recommended that you set the current color of a color well with a color whose type matches that of the current document's color model.

◆ ~ColorWell()

virtual hdi::core::ColorWell::~ColorWell ( )
virtual

ColorWell destructor.

Author
GW
Date
09/2013

Member Function Documentation

◆ clone()

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

Convenience method to clone a ColorWell object on the heap.

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

Implements hdi::core::Widget.

◆ currentColor()

virtual ArtColor hdi::core::ColorWell::currentColor ( ) const
virtual

Gets the current value of the color well.

Author
GW
Date
09/2013
Returns
An ArtColor object representing the current color of the color well

◆ duplicate()

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

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

Implements hdi::core::Widget.

◆ operator=()

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

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

◆ setCurrentColor()

virtual void hdi::core::ColorWell::setCurrentColor ( const ArtColor color_)
virtual

Sets the current value of the color well.

Author
GW
Date
09/2013
Parameters
color_New color values for the color well
Note
The type of color with which a ColorWell is "seeded" (the color it has before the color picker is shown) will affect the type of color that is reported by the currentColor() method (e.g. in a value-changed callback). It is recommended that you set the current color of a color well with a color whose type matches that of the current document's color model.

◆ setValueChangedCallback()

virtual void hdi::core::ColorWell::setValueChangedCallback ( const Callback callback_)
virtual

Sets the value changed callback.

Author
GW
Date
09/2013
Parameters
callback_New callback for when the color well's value has changed

◆ valueChanged()

virtual void hdi::core::ColorWell::valueChanged ( )
virtual

Simulates the color well having its value changed.

Author
GW
Date
09/2013

◆ valueChangedCallback()

virtual Callback* const hdi::core::ColorWell::valueChangedCallback ( ) const
virtual

Gets the value changed callback for the color well.

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