Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
|
Used to add a panel to Illustrator's UI and contain various UI widgets. More...
#include <hdicorePanel.h>
Public Member Functions | |
Panel () | |
Constructs an empty Panel object. | |
Panel (const Panel &p_) | |
Constructs a new Panel object from an existing Panel object (copy constructor) | |
Panel (const std::string &name_, const Size &size_, const bool resizableW_, const bool resizableH_, const ImageIDs &iconIDs_) | |
Constructs a new Panel object. | |
Panel (const std::string &name_, const Size &size_, const bool resizableW_, const bool resizableH_, const SVGIDs &iconIDs_) | |
Constructs a new Panel object. | |
virtual | ~Panel () |
Destructs a Panel object. | |
virtual Panel & | operator= (const Panel &rhs_) |
Allows one Panel object to be assigned from another. | |
virtual Panel * | clone () const |
Convenience method to clone a Panel object on the heap. | |
virtual void | destroy () |
Destroys the UI panel, converting the target object to an empty Panel object (see the default constructor for more info on empty Panel objects) | |
virtual PlatformPanelPtr | platformPanel () const |
Gets the platform-specific panel, around which the target object is wrapped. | |
virtual void | show () |
Shows the panel. | |
virtual void | hide () |
Hides the panel. | |
virtual bool | visible () const |
Gets whether the panel is visible. | |
virtual void | setVisible (const bool visible_) |
Sets panel visibility. | |
virtual Rect | frame () const |
Gets the panel's frame. | |
virtual void | setFrame (const Rect &frame_) |
Sets the panel's frame (location and size) | |
virtual void | setSize (const Size &s_) |
Sets the panel's dimensions. | |
virtual void | setHeight (const double height_) |
Sets the panel's height (keeping the location and width the same) | |
virtual Size | minimumSize () const |
Gets the minimum panel size, if the panel is resizeable in any direction (otherwise, the minimum matches the current size) | |
virtual void | setMinimumSize (const Size &min_) |
Sets the minimum panel size, if the panel is resizeable in any direction (otherwise, the minimum always matches the current size) | |
virtual Size | maximumSize () const |
Gets the maximum panel size, if the panel is resizeable in any direction (otherwise, the maximum matches the current size) | |
virtual void | setMaximumSize (const Size &max_) |
Sets the maximum panel size, if the panel is resizeable in any direction (otherwise, the maximum always matches the current size) | |
virtual bool | addWidget (const Widget &widget_) |
Adds a widget (label, button, text field, etc.) to the panel. | |
virtual bool | removeWidget (const Widget &widget_) |
Removes a widget (label, button, text field, etc.) from the panel. | |
std::string | title () const |
Gets the current panel title. | |
void | setTitle (const std::string &title_) |
Sets the current panel title. | |
virtual Flyout *const | flyoutMenu () const |
Gets the current flyout menu for the panel, or NULL if none. | |
virtual void | setFlyoutMenu (const Flyout &flyout_) |
Sets/updates the flyout menu for the panel. | |
virtual Callback *const | showCallback () const |
Gets the registered callback for the panel showing, or NULL if none. | |
virtual void | setShowCallback (const Callback &cb_) |
Sets/updates the callback for the panel showing. | |
virtual Callback *const | hideCallback () const |
Gets the registered callback for the panel hiding, or NULL if none. | |
virtual void | setHideCallback (const Callback &cb_) |
Sets/updates the callback for the panel hiding. | |
virtual Callback *const | resizeCallback () const |
Gets the callback set for the panel resize, or NULL if none. | |
virtual void | setResizeCallback (const Callback &cb_) |
Sets/updates the callback for the panel resize. | |
virtual void | update () const |
Forces the widgets in the panel to update/redraw (including the flyout, if any) | |
Public Member Functions inherited from hdi::core::Window | |
virtual | ~Window () |
Destructs a Window object. | |
virtual Window * | clone () const =0 |
Convenience method to clone a Window object, taking its subclass type into account for proper memory management. | |
virtual bool | isEmpty () const |
Gets whether the target Window object is empty (constructed with the default ctor) | |
virtual WindowType | windowType () |
Gets the type of window. | |
virtual bool | operator== (const Window &rhs_) const |
Tests whether a given Window object is the same as another. | |
virtual bool | operator!= (const Window &rhs_) const |
Tests whether a given Window object is not the same as another. | |
virtual bool | visible () const =0 |
Gets whether the window is visible. | |
virtual void | show ()=0 |
Shows the window. | |
virtual const WidgetVector | widgets () const |
Gets a list of all widgets contained by the target window. | |
virtual bool | addWidget (const Widget &widget_) |
Adds a widget (label, button, text field, etc.) to the window. | |
virtual bool | removeWidget (const Widget &widget_) |
Removes a widget (label, button, text field, etc.) from the window. | |
virtual bool | addWidgetGroup (const WidgetGroup &wg_) |
Adds a widget group to the window. | |
virtual bool | removeWidgetGroup (const WidgetGroup &wg_) |
Removes a widget group from the window. | |
virtual TabOrder *const | tabOrder () const |
Gets the tab order object for the window. | |
virtual void | update () const =0 |
Forces the widgets in the modal dialog to update/redraw. | |
virtual double | scalingFactor () const |
Gets the factor by which the UI is scaled for the given window (i.e. for HiDPI support) | |
Static Public Attributes | |
static const double | typicalWidth |
Most Illustrator panels are this width. | |
Friends | |
class | Flyout |
pui::Panel * | __accessImpl (const Panel &) |
Panel | __accessCtor (pui::Panel *const) |
Additional Inherited Members | |
Public Types inherited from hdi::core::Window | |
typedef std::vector< std::shared_ptr< Widget > > | WidgetVector |
Protected Member Functions inherited from hdi::core::Window | |
Window () | |
Constructs an empty Window object. | |
Window (const Window &w_) | |
Constructs a new Window object from an existing Window object (copy constructor) | |
Window (const WindowType type_) | |
Constructs a Window object. | |
virtual Window & | operator= (const Window &) |
Internal use only. | |
Protected Attributes inherited from hdi::core::Window | |
void * | _data |
Private implementation data. | |
Used to add a panel to Illustrator's UI and contain various UI widgets.
hdi::core::Panel::Panel | ( | ) |
Constructs an empty Panel object.
hdi::core::Panel::Panel | ( | const Panel & | p_ | ) |
hdi::core::Panel::Panel | ( | const std::string & | name_, |
const Size & | size_, | ||
const bool | resizableW_, | ||
const bool | resizableH_, | ||
const ImageIDs & | iconIDs_ | ||
) |
Constructs a new Panel object.
name_ | Name/title of the panel (must be unique), as UTF-8 |
size_ | Size (width and height) of the panel, in 1x resolution coordinates |
resizableW_ | Whether the panel width can be resized |
resizableH_ | Whether the panel height can be resized |
iconIDs_ | PNGI resource IDs for the dock icon |
hdi::core::Panel::Panel | ( | const std::string & | name_, |
const Size & | size_, | ||
const bool | resizableW_, | ||
const bool | resizableH_, | ||
const SVGIDs & | iconIDs_ | ||
) |
Constructs a new Panel object.
name_ | Name/title of the panel (must be unique), as UTF-8 |
size_ | Size (width and height) of the panel, in 1x resolution coordinates |
resizableW_ | Whether the panel width can be resized |
resizableH_ | Whether the panel height can be resized |
iconIDs_ | SVG resource IDs for the dock icon |
|
virtual |
Destructs a Panel object.
|
virtual |
Adds a widget (label, button, text field, etc.) to the panel.
widget_ | Widget to place in the panel |
Reimplemented from hdi::core::Window.
|
virtual |
Convenience method to clone a Panel object on the heap.
Implements hdi::core::Window.
|
virtual |
Destroys the UI panel, converting the target object to an empty Panel object (see the default constructor for more info on empty Panel objects)
|
virtual |
|
virtual |
Gets the panel's frame.
|
virtual |
Hides the panel.
|
virtual |
Gets the registered callback for the panel hiding, or NULL if none.
|
virtual |
Gets the maximum panel size, if the panel is resizeable in any direction (otherwise, the maximum matches the current size)
|
virtual |
Gets the minimum panel size, if the panel is resizeable in any direction (otherwise, the minimum matches the current size)
|
virtual |
Gets the platform-specific panel, around which the target object is wrapped.
|
virtual |
Removes a widget (label, button, text field, etc.) from the panel.
widget_ | Widget to remove from the panel |
Reimplemented from hdi::core::Window.
|
virtual |
Gets the callback set for the panel resize, or NULL if none.
|
virtual |
Sets/updates the flyout menu for the panel.
flyout_ | New flyout menu |
|
virtual |
Sets the panel's frame (location and size)
frame_ | New panel frame, in 1x resolution coordinates |
|
virtual |
Sets the panel's height (keeping the location and width the same)
height_ | New panel height, at 1x resolution |
|
virtual |
Sets/updates the callback for the panel hiding.
cb_ | New callback for a user hiding the panel |
|
virtual |
Sets the maximum panel size, if the panel is resizeable in any direction (otherwise, the maximum always matches the current size)
min_ | The new maximum panel dimensions, at 1x resolution; ignored if the panel is not resizeable |
|
virtual |
Sets the minimum panel size, if the panel is resizeable in any direction (otherwise, the minimum always matches the current size)
min_ | The new minimum panel dimensions, at 1x resolution; ignored if the panel is not resizeable |
|
virtual |
Sets/updates the callback for the panel resize.
cb_ | New callback for a user resizing the panel |
|
virtual |
Sets/updates the callback for the panel showing.
cb_ | New callback for a user showing the panel |
|
virtual |
Sets the panel's dimensions.
s_ | New panel size, at 1x resolution |
void hdi::core::Panel::setTitle | ( | const std::string & | title_ | ) |
Sets the current panel title.
title_ | New string value for the panel title, as UTF-8 |
|
virtual |
|
virtual |
|
virtual |
Gets the registered callback for the panel showing, or NULL if none.
std::string hdi::core::Panel::title | ( | ) | const |
Gets the current panel title.
|
virtual |
Forces the widgets in the panel to update/redraw (including the flyout, if any)
Implements hdi::core::Window.
|
virtual |
Gets whether the panel is visible.
Implements hdi::core::Window.