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

WebView widget, for loading a website within an Illustrator window. More...

#include <hdicoreWebView.h>

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

Public Member Functions

 WebView ()
 Constructs an empty WebView object. More...
 
 WebView (const WebView &wv_)
 Constructs a new WebView object from an existing WebView object (copy constructor) More...
 
 WebView (const Rect &frame_)
 Constructs a web view with a given frame. More...
 
virtual ~WebView ()
 WebView destructor. More...
 
virtual WebViewoperator= (const WebView &rhs_)
 Allows one WebView object to be assigned from another. More...
 
virtual WebViewclone () const
 Convenience method to clone a WebView object on the heap. More...
 
virtual WebViewduplicate () const
 Convenience method to duplicate a WebView object, creating a new and identical UI element to the target (but not belonging to the same containing window) More...
 
virtual std::string text () const
 Does nothing (web views do not have a text value) More...
 
virtual void setText (const std::string &text_)
 Does nothing (web views do not have a text value) More...
 
virtual std::string tooltip () const
 Does nothing (web views do not have a tooltip) More...
 
virtual void setTooltip (const std::string &tip_)
 Does nothing (web views do not have a tooltip) More...
 
virtual void loadURL (const std::string &url_)
 Loads the given HTTP(S) URL. More...
 
virtual void stopLoading ()
 Stops any page loading that might be occurring. More...
 
virtual void reload ()
 Reloads the currently loaded page, if any. More...
 
virtual bool goBack ()
 Goes back one step in the browsing history. More...
 
virtual bool goForward ()
 Goes forward one step in the browsing history. More...
 
virtual bool isLoading () const
 Gets whether the target web view is currently loading a page. More...
 
virtual double estimatedProgress () const
 Gets an estimate of the current loading progress. More...
 
- Public Member Functions inherited from hdi::core::Widget
(virtual) - ~Widget
 Destructs a Widget. More...
 
(virtual PlatformWidgetPtr) - platformWidget
 Gets the platform-specific widget, around which the target object is wrapped. More...
 
(virtual bool) - isEmpty
 Gets whether the target Widget object is empty (constructed with the default ctor) More...
 
(virtual bool) - operator==
 Tests whether a given Widget object is the same as another. More...
 
(virtual bool) - operator!=
 Tests whether a given Widget object is not the same as another. More...
 
(virtual Type- type
 Gets the type of the widget. More...
 
(virtual Window *const) - window
 Gets the parent window of the widget. More...
 
(virtual Rect- frame
 Gets the widget frame. More...
 
(virtual void) - setFrame
 Sets the widget frame. More...
 
(virtual void) - offset
 Offsets the widget from its current location by the given amounts. More...
 
(virtual bool) - enabled
 Gets whether the widget is enabled. More...
 
(virtual void) - setEnabled
 Enables or disables the widget. More...
 
(virtual bool) - visible
 Gets whether the widget is visible. More...
 
(virtual void) - setVisible
 Shows or hides the widget. More...
 
(virtual void) - setOrigin
 Convenience method to set just the origin of the target widget's frame. More...
 
(virtual void) - setSize
 Convenience method to set just the size of the target widget's frame. More...
 
(virtual void) - setWidth
 Convenience method to set just the width of the target widget's frame. More...
 
(virtual void) - setHeight
 Convenience method to set just the height of the target widget's frame. More...
 
(virtual bool) - hasFocus
 Gets whether the widget currently has focus. More...
 
(virtual void) - focus
 Forces the widget to have focus, taking it from any other focused widget of the same window. More...
 
(virtual void) - blur
 Removes focus from 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.
 
typedef std::auto_ptr< ImageIDsImageIDsAP
 
- Static Public Member Functions inherited from hdi::core::Widget
(static bool) + isCoreWidget
 Gets whether the given platform widget is a hdi_core widget. More...
 
(static std::auto_ptr< Widget >) + lastClickedWidget
 Gets the last widget that received a click event (either by the user or programmatically) More...
 
(static std::auto_ptr< Widget >) + lastValueChangingWidget
 Gets the last widget that received a value changing event (either by the user or programmatically) More...
 
(static std::auto_ptr< Widget >) + lastValueChangedWidget
 Gets the last widget that received a value changed event (either by the user or programmatically) More...
 
(static bool) + forceIdeographicFontSize
 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
 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
 Internal use only. More...
 
() - Widget
 Constructs an empty Widget object. More...
 
() - Widget
 Constructs a new Widget object from an existing Widget object (copy constructor) More...
 
() - Widget
 Internal use only. More...
 
(virtual Widget &) - operator=
 Internal use only. More...
 
- Protected Attributes inherited from hdi::core::Widget
void * _data
 Private implementation data.
 

Detailed Description

WebView widget, for loading a website within an Illustrator window.

Constructor & Destructor Documentation

hdi::core::WebView::WebView ( )

Constructs an empty WebView object.

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

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

Author
GW
Date
09/2015
Parameters
wv_Existing WebView object
hdi::core::WebView::WebView ( const Rect frame_)

Constructs a web view with a given frame.

Author
GW
Date
09/2015
Parameters
frame_Frame of the web view
virtual hdi::core::WebView::~WebView ( )
virtual

WebView destructor.

Author
GW
Date
09/2015

Member Function Documentation

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

Convenience method to clone a WebView object on the heap.

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

Implements hdi::core::Widget.

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

Convenience method to duplicate a WebView object, creating a new and identical UI element to the target (but not belonging to the same containing window)

Author
GW
Date
09/2015
Returns
A pointer to the new WebView object (and new UI element)
Warning
The caller must manage the memory for the returned WebView object.

Implements hdi::core::Widget.

virtual double hdi::core::WebView::estimatedProgress ( ) const
virtual

Gets an estimate of the current loading progress.

Author
GW
Date
09/2015
Returns
The loading progress, in range [0.0, 1.0]
virtual bool hdi::core::WebView::goBack ( )
virtual

Goes back one step in the browsing history.

Author
GW
Date
09/2015
Returns
true if a previous page was available, and whose loading was begun
virtual bool hdi::core::WebView::goForward ( )
virtual

Goes forward one step in the browsing history.

Author
GW
Date
09/2015
Returns
true if a subsequent page was available, and whose loading was begun
virtual bool hdi::core::WebView::isLoading ( ) const
virtual

Gets whether the target web view is currently loading a page.

Author
GW
Date
09/2015
Returns
true if still loading, false otherwise
virtual void hdi::core::WebView::loadURL ( const std::string &  url_)
virtual

Loads the given HTTP(S) URL.

Author
GW
Date
09/2015
Parameters
url_Target URL to load
virtual WebView& hdi::core::WebView::operator= ( const WebView rhs_)
virtual

Allows one WebView object to be assigned from another.

Author
GW
Date
09/2015
Parameters
rhs_Righthand side of the = operator; the object to copy values from
Returns
The target WebView object, but with its value updated to match that of rhs_
virtual void hdi::core::WebView::reload ( )
virtual

Reloads the currently loaded page, if any.

Author
GW
Date
09/2015
virtual void hdi::core::WebView::setText ( const std::string &  text_)
virtual

Does nothing (web views do not have a text value)

Author
GW
Date
09/2015
Parameters
text_Ignored

Reimplemented from hdi::core::Widget.

virtual void hdi::core::WebView::setTooltip ( const std::string &  tip_)
virtual

Does nothing (web views do not have a tooltip)

Author
GW
Date
09/2015
Parameters
tip_Ignored

Reimplemented from hdi::core::Widget.

virtual void hdi::core::WebView::stopLoading ( )
virtual

Stops any page loading that might be occurring.

Author
GW
Date
09/2015
virtual std::string hdi::core::WebView::text ( ) const
virtual

Does nothing (web views do not have a text value)

Author
GW
Date
09/2015
Returns
""

Reimplemented from hdi::core::Widget.

virtual std::string hdi::core::WebView::tooltip ( ) const
virtual

Does nothing (web views do not have a tooltip)

Author
GW
Date
09/2015
Returns
""

Reimplemented from hdi::core::Widget.