clan::ViewAction Class Reference

Recognizes actions in a view and captures input for the duration of the action. More...

#include <view_action.h>

+ Inheritance diagram for clan::ViewAction:

Public Member Functions

 ViewAction ()
 
virtual ~ViewAction ()
 
bool action_active () const
 Returns true if the action is capturing events. More...
 
virtual void activated (ActivationChangeEvent &e)
 Handler for when the application is activated. More...
 
virtual void any_event (EventUI *e)
 Handler for any UI event. More...
 
void begin_action ()
 Captures events until end is called. More...
 
virtual void deactivated (ActivationChangeEvent &e)
 Handler for when the application is deactivated. More...
 
void end_action ()
 Releases capture of events. More...
 
virtual void focus_gained (FocusChangeEvent &e)
 Handler for focus gained events. More...
 
virtual void focus_lost (FocusChangeEvent &e)
 Handler for focus lost events. More...
 
virtual void key_press (KeyEvent &e)
 Handler for key press events. More...
 
virtual void key_release (KeyEvent &e)
 Handler for key release events. More...
 
virtual void pointer_double_click (PointerEvent &e)
 Handler for pointer double click events. More...
 
virtual void pointer_enter (PointerEvent &e)
 Handler for pointer enter events. More...
 
virtual void pointer_leave (PointerEvent &e)
 Handler for pointer leave events. More...
 
virtual void pointer_move (PointerEvent &e)
 Handler for pointer movement events. More...
 
virtual void pointer_press (PointerEvent &e)
 Handler for pointer press events. More...
 
virtual void pointer_proximity_change (PointerEvent &e)
 Handler for pointer proximity change events. More...
 
virtual void pointer_release (PointerEvent &e)
 Handler for pointer release events. More...
 
void remove_from_view ()
 Removes recognizer from the view it is attached to. More...
 
Viewview () const
 Returns the view the action is attached to. More...
 
template<typename T >
T * view () const
 

Friends

class View
 
class ViewActionImpl
 
class ViewTree
 

Detailed Description

Recognizes actions in a view and captures input for the duration of the action.

Constructor & Destructor Documentation

clan::ViewAction::ViewAction ( )
virtual clan::ViewAction::~ViewAction ( )
virtual

Member Function Documentation

bool clan::ViewAction::action_active ( ) const

Returns true if the action is capturing events.

virtual void clan::ViewAction::activated ( ActivationChangeEvent e)
inlinevirtual

Handler for when the application is activated.

virtual void clan::ViewAction::any_event ( EventUI e)
inlinevirtual

Handler for any UI event.

void clan::ViewAction::begin_action ( )

Captures events until end is called.

virtual void clan::ViewAction::deactivated ( ActivationChangeEvent e)
inlinevirtual

Handler for when the application is deactivated.

void clan::ViewAction::end_action ( )

Releases capture of events.

virtual void clan::ViewAction::focus_gained ( FocusChangeEvent e)
inlinevirtual

Handler for focus gained events.

virtual void clan::ViewAction::focus_lost ( FocusChangeEvent e)
inlinevirtual

Handler for focus lost events.

virtual void clan::ViewAction::key_press ( KeyEvent e)
inlinevirtual

Handler for key press events.

virtual void clan::ViewAction::key_release ( KeyEvent e)
inlinevirtual

Handler for key release events.

virtual void clan::ViewAction::pointer_double_click ( PointerEvent e)
inlinevirtual

Handler for pointer double click events.

virtual void clan::ViewAction::pointer_enter ( PointerEvent e)
inlinevirtual

Handler for pointer enter events.

virtual void clan::ViewAction::pointer_leave ( PointerEvent e)
inlinevirtual

Handler for pointer leave events.

virtual void clan::ViewAction::pointer_move ( PointerEvent e)
inlinevirtual

Handler for pointer movement events.

virtual void clan::ViewAction::pointer_press ( PointerEvent e)
inlinevirtual

Handler for pointer press events.

virtual void clan::ViewAction::pointer_proximity_change ( PointerEvent e)
inlinevirtual

Handler for pointer proximity change events.

virtual void clan::ViewAction::pointer_release ( PointerEvent e)
inlinevirtual

Handler for pointer release events.

void clan::ViewAction::remove_from_view ( )

Removes recognizer from the view it is attached to.

View* clan::ViewAction::view ( ) const

Returns the view the action is attached to.

template<typename T >
T* clan::ViewAction::view ( ) const
inline

Friends And Related Function Documentation

friend class View
friend
friend class ViewActionImpl
friend
friend class ViewTree
friend

The documentation for this class was generated from the following file: