NAME

       SoScXMLEvent -

       Adds an SoEvent holder to the ScXMLEvent base.

SYNOPSIS

       #include <Inventor/scxml/SoScXMLEvent.h>

       Inherits ScXMLEvent.

   Public Member Functions
       virtual SoType getTypeId (void) const
           Returns the type identification of an object derived from a class inheriting SoBase.
           This is used for run-time type checking and 'downward' casting.
       virtual void setSoEvent (const SoEvent *soevent)
       virtual const SoEvent * getSoEvent (void) const
       virtual void setUpIdentifier (void)
       virtual void copyContents (const ScXMLEvent *rhs)

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static void * createInstance (void)
       static void initClass (void)
       static void cleanClass (void)

   Additional Inherited Members

Detailed Description

       Adds an SoEvent holder to the ScXMLEvent base.

       This class is part of integrating the Coin types with the SCXML subsystem. SoScXMLEvent
       objects are ScXMLEvents that wraps/passes an SoEvent to the SCXML state machine.

       Since:
           Coin 3.0

Member Function Documentation

   SoType SoScXMLEvent::getTypeId (void) const [virtual]
       Returns the type identification of an object derived from a class inheriting SoBase. This
       is used for run-time type checking and 'downward' casting.

       See Also:
           SoBase::getTypeId() const

       Reimplemented from ScXMLEvent.

   void SoScXMLEvent::setSoEvent (const SoEvent *soevent) [virtual]
       This function stores a pointer to the originator SoEvent that caused the given event, if
       any.

       The event is duplicated when set, and can be deleted immediately by the caller.

       See Also:
           setUpIdentifiers

   const SoEvent * SoScXMLEvent::getSoEvent (void) const [virtual]
       Returns the pointer to the stored SoEvent or NULL if no event has been stored yet.

       See Also:
           setSoEvent

   void SoScXMLEvent::setUpIdentifier (void) [virtual]
       This method updates the ScXMLEvent event class and event identifier strings based on the
       set SoEvent object.

       The identifiers will be cleared if no SoEvent object has been stored.

       See Also:
           setSoEvent

Author

       Generated automatically by Doxygen for Coin from the source code.