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

Allows for finer control of widget focus/tab key ordering. More...

#include <hdicoreTabOrder.h>

Public Types

typedef std::list< Widget * > WidgetList
 

Public Member Functions

virtual bool operator== (const TabOrder &rhs_) const
 Tests whether a given TabOrder object is the same as another. More...
 
virtual bool operator!= (const TabOrder &rhs_) const
 Tests whether a given TabOrder object is not the same as another. More...
 
virtual bool hasWidget (const Widget &widget_) const
 Checks whether the target TabOrder object already contains a given widget. More...
 
virtual const WidgetList widgets () const
 Gets the list of widgets affected by the target TabOrder object. More...
 
virtual Widget *const front () const
 Gets the Widget object that is at the front of the target TabOrder object. More...
 
virtual void pushFront (const Widget &widget_)
 Pushes a new Widget object on the front of the list for the target TabOrder. More...
 
virtual bool popFront (std::auto_ptr< Widget > &widget__)
 Gets the Widget at the front of the target TabOrder, and pops it. More...
 
virtual Widget *const back () const
 Gets the Widget object that is at the back of the target TabOrder object. More...
 
virtual void pushBack (const Widget &widget_)
 Pushes a new Widget object on the back of the list for the target TabOrder. More...
 
virtual bool popBack (std::auto_ptr< Widget > &widget__)
 Gets the Widget at the back of the target TabOrder, and pops it. More...
 
virtual void focusNext (const Widget &position_)
 Focuses the next (enabled) widget after the one provided. More...
 
virtual void focusPrevious (const Widget &position_)
 Focuses the previous (enabled) widget before the one provided. More...
 

Friends

class Window
 

Detailed Description

Allows for finer control of widget focus/tab key ordering.

Member Function Documentation

virtual Widget* const hdi::core::TabOrder::back ( ) const
virtual

Gets the Widget object that is at the back of the target TabOrder object.

Author
GW
Date
09/2013
Returns
The backmost Widget object, or NULL if none
virtual void hdi::core::TabOrder::focusNext ( const Widget position_)
virtual

Focuses the next (enabled) widget after the one provided.

Author
GW
Date
09/2013
Parameters
position_Widget immediately before the one that should be focused (typically, the currently focused widget is passed)
virtual void hdi::core::TabOrder::focusPrevious ( const Widget position_)
virtual

Focuses the previous (enabled) widget before the one provided.

Author
GW
Date
09/2013
Parameters
position_Widget immediately after the one that should be focused (typically, the currently focused widget is passed)
virtual Widget* const hdi::core::TabOrder::front ( ) const
virtual

Gets the Widget object that is at the front of the target TabOrder object.

Author
GW
Date
09/2013
Returns
The frontmost Widget object, or NULL if none
virtual bool hdi::core::TabOrder::hasWidget ( const Widget widget_) const
virtual

Checks whether the target TabOrder object already contains a given widget.

Author
GW
Date
09/2013
Parameters
widget_The widget to check for existence in the TabOrder object
Returns
true if the target contains the given widget, false otherwise
virtual bool hdi::core::TabOrder::operator!= ( const TabOrder rhs_) const
virtual

Tests whether a given TabOrder object is not the same as another.

Author
GW
Date
09/2013
Parameters
rhs_TabOrder to compare against (righthand side of inequality operator)
Returns
true for the target and rhs_ being different UI widgets, false otherwise
virtual bool hdi::core::TabOrder::operator== ( const TabOrder rhs_) const
virtual

Tests whether a given TabOrder object is the same as another.

Author
GW
Date
09/2013
Parameters
rhs_TabOrder to compare against (righthand side of equality operator)
Returns
true for the target and rhs_ being the same UI widget, false otherwise
virtual bool hdi::core::TabOrder::popBack ( std::auto_ptr< Widget > &  widget__)
virtual

Gets the Widget at the back of the target TabOrder, and pops it.

Author
GW
Date
09/2013
Parameters
widget__Return-by-reference for the Widget object at the back
Returns
true if the widget at the back was popped and acquired, false otherwise
virtual bool hdi::core::TabOrder::popFront ( std::auto_ptr< Widget > &  widget__)
virtual

Gets the Widget at the front of the target TabOrder, and pops it.

Author
GW
Date
09/2013
Parameters
widget__Return-by-reference for the frontmost Widget object
Returns
true if the frontmost widget was popped and acquired, false otherwise
virtual void hdi::core::TabOrder::pushBack ( const Widget widget_)
virtual

Pushes a new Widget object on the back of the list for the target TabOrder.

Author
GW
Date
09/2013
Parameters
widget_The widget to add to the back of the tab order
virtual void hdi::core::TabOrder::pushFront ( const Widget widget_)
virtual

Pushes a new Widget object on the front of the list for the target TabOrder.

Author
GW
Date
09/2013
Parameters
widget_The widget to add to the front of the tab order
virtual const WidgetList hdi::core::TabOrder::widgets ( ) const
virtual

Gets the list of widgets affected by the target TabOrder object.

Author
GW
Date
09/2013
Returns
A vector containing all widgets affected by the tab order