Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes

nsAccEvent Class Reference

#include <nsAccessibleEventData.h>

Inheritance diagram for nsAccEvent:
Collaboration diagram for nsAccEvent:

List of all members.

Classes

class  cycleCollection

Public Types

enum  EEventRule { eAllowDupes, eCoalesceFromSameSubtree, eRemoveDupes, eDoNotEmit }

Public Member Functions

 nsAccEvent (PRUint32 aEventType, nsIAccessible *aAccessible, PRBool aIsAsynch=0, EEventRule aEventRule=eRemoveDupes)
 nsAccEvent (PRUint32 aEventType, nsIDOMNode *aDOMNode, PRBool aIsAsynch=0, EEventRule aEventRule=eRemoveDupes)
virtual ~nsAccEvent ()

Static Public Member Functions

static
NS_DECL_NSIACCESSIBLEEVENT
void 
GetLastEventAttributes (nsIDOMNode *aNode, nsIPersistentProperties *aAttributes)
static PRUint32 EventType (nsIAccessibleEvent *aAccEvent)
static EEventRule EventRule (nsIAccessibleEvent *aAccEvent)
static PRBool IsAsyncEvent (nsIAccessibleEvent *aAccEvent)
static PRBool IsFromUserInput (nsIAccessibleEvent *aAccEvent)
static void ResetLastInputState ()
static void PrepareForEvent (nsIDOMNode *aChangeNode, PRBool aForceIsFromUserInput=0)
 Find and cache the last input state.
static void PrepareForEvent (nsIAccessibleEvent *aEvent, PRBool aForceIsFromUserInput=0)
 The input state was previously stored with the nsIAccessibleEvent, so use that state now -- call this when about to flush an event that was waiting in an event queue.
static void ApplyEventRules (nsTArray< nsRefPtr< nsAccEvent > > &aEventsToFire)
 Apply event rules to pending events, this method is called in FlushingPendingEvents().

Static Public Attributes

static cycleCollection _cycleCollectorGlobal

Protected Member Functions

already_AddRefed< nsIAccessibleGetAccessibleByNode ()
void CaptureIsFromUserInput ()

Protected Attributes

PRBool mIsFromUserInput
PRUint32 mEventType
EEventRule mEventRule
PRPackedBool mIsAsync
nsCOMPtr< nsIAccessiblemAccessible
nsCOMPtr< nsIDOMNodemDOMNode
nsCOMPtr< nsIAccessibleDocumentmDocAccessible

Member Enumeration Documentation

Enumerator:
eAllowDupes 
eCoalesceFromSameSubtree 
eRemoveDupes 
eDoNotEmit 

Constructor & Destructor Documentation

nsAccEvent::nsAccEvent ( PRUint32  aEventType,
nsIAccessible aAccessible,
PRBool  aIsAsynch = 0,
EEventRule  aEventRule = eRemoveDupes 
)
nsAccEvent::nsAccEvent ( PRUint32  aEventType,
nsIDOMNode aDOMNode,
PRBool  aIsAsynch = 0,
EEventRule  aEventRule = eRemoveDupes 
)
virtual nsAccEvent::~nsAccEvent (  )  [inline, virtual]

Member Function Documentation

static void nsAccEvent::ApplyEventRules ( nsTArray< nsRefPtr< nsAccEvent > > &  aEventsToFire  )  [static]

Apply event rules to pending events, this method is called in FlushingPendingEvents().

Result of this method: Event rule of filtered events will be set to eDoNotEmit. Events with other event rule are good to emit.

void nsAccEvent::CaptureIsFromUserInput (  )  [protected]
static EEventRule nsAccEvent::EventRule ( nsIAccessibleEvent aAccEvent  )  [inline, static]
static PRUint32 nsAccEvent::EventType ( nsIAccessibleEvent aAccEvent  )  [inline, static]
already_AddRefed<nsIAccessible> nsAccEvent::GetAccessibleByNode (  )  [protected]
static NS_DECL_NSIACCESSIBLEEVENT void nsAccEvent::GetLastEventAttributes ( nsIDOMNode aNode,
nsIPersistentProperties aAttributes 
) [static]
static PRBool nsAccEvent::IsAsyncEvent ( nsIAccessibleEvent aAccEvent  )  [inline, static]
static PRBool nsAccEvent::IsFromUserInput ( nsIAccessibleEvent aAccEvent  )  [inline, static]
static void nsAccEvent::PrepareForEvent ( nsIDOMNode aChangeNode,
PRBool  aForceIsFromUserInput = 0 
) [static]

Find and cache the last input state.

This will be called automatically for synchronous events. For asynchronous events it should be called from the synchronous code which is the true source of the event, before the event is fired.

Parameters:
aChangeNode that event will be on
aForceIsFromUserInput PR_TRUE if the caller knows that this event was caused by user input
static void nsAccEvent::PrepareForEvent ( nsIAccessibleEvent aEvent,
PRBool  aForceIsFromUserInput = 0 
) [static]

The input state was previously stored with the nsIAccessibleEvent, so use that state now -- call this when about to flush an event that was waiting in an event queue.

static void nsAccEvent::ResetLastInputState (  )  [inline, static]

Member Data Documentation

PRUint32 nsAccEvent::mEventType [protected]

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