.TH "SoScXMLEvent" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoScXMLEvent \- Adds an \fBSoEvent\fP holder to the \fBScXMLEvent\fP base\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/scxml/SoScXMLEvent\&.h>\fP
.PP
Inherits \fBScXMLEvent\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.RI "Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&.   "
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsetSoEvent\fP (\fBconst\fP \fBSoEvent\fP *\fBsoevent\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBconst\fP \fBSoEvent\fP * \fBgetSoEvent\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsetUpIdentifier\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcopyContents\fP (\fBconst\fP \fBScXMLEvent\fP *rhs)"
.br
.in -1c

Public Member Functions inherited from \fBScXMLEvent\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsetEventName\fP (\fBconst\fP \fBSbName\fP &name)"
.br
.ti -1c
.RI "\fBconst\fP \fBSbName\fP & \fBgetEventName\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBScXMLEvent\fP * \fBclone\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetAssociation\fP (\fBconst\fP char *key, \fBconst\fP char *value)"
.br
.ti -1c
.RI "\fBconst\fP char * \fBgetAssociation\fP (\fBconst\fP char *key) \fBconst\fP"
.br
.ti -1c
.RI "size_t \fBgetNumAssociations\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "size_t \fBgetAssociationKeys\fP (\fBSbList\fP< \fBconst\fP char * > &keys) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBScXMLObject\fP
.in +1c
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBSoType\fP type) \fBconst\fP"
.br
.RI "Returns \fCTRUE\fP if the type of this object is either of the same type or inherited from \fItype\fP\&.   "
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP * \fBcreateInstance\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcleanClass\fP (\fBvoid\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBScXMLEvent\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP * \fBcreateInstance\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcleanClass\fP (\fBvoid\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBScXMLObject\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&.   "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.   "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcleanClass\fP (\fBvoid\fP)"
.br
.RI "Does the opposite of initClass, deallocates any class specific resources and resets the class to an uninitialized state with respect to the Coin type system\&. "
.in -1c
.SS "Additional Inherited Members"


Static Protected Member Functions inherited from \fBScXMLObject\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBregisterClassType\fP (\fBconst\fP char *xmlns, \fBconst\fP char *\fBclassname\fP, \fBSoType\fP type)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBregisterInvokeClassType\fP (\fBconst\fP char *xmlns, \fBconst\fP char *targettype, \fBconst\fP char *source, \fBSoType\fP type)"
.br
.in -1c

Protected Attributes inherited from \fBScXMLEvent\fP
.in +1c
.ti -1c
.RI "\fBSbName\fP \fBname\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Adds an \fBSoEvent\fP holder to the \fBScXMLEvent\fP base\&. 

This class is part of integrating the Coin types with the SCXML subsystem\&. \fBSoScXMLEvent\fP objects are ScXMLEvents that wraps/passes an \fBSoEvent\fP to the SCXML state machine\&.
.PP
\fBSince\fP
.RS 4
Coin \fB3\&.0\fP 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoScXMLEvent::getTypeId (\fBvoid\fP) const\fC [virtual]\fP"

.PP
Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&.   
.PP
\fBSee also\fP
.RS 4
\fBSoBase::getTypeId() const\fP 
.RE
.PP

.PP
Reimplemented from \fBScXMLEvent\fP\&.
.SS "\fBvoid\fP SoScXMLEvent::setSoEvent (\fBconst\fP \fBSoEvent\fP * soevent)\fC [virtual]\fP"
This function stores a pointer to the originator \fBSoEvent\fP that caused the given event, if any\&.
.PP
The event is duplicated when set, and can be deleted immediately by the caller\&.
.PP
\fBSee also\fP
.RS 4
setUpIdentifiers 
.RE
.PP

.SS "\fBconst\fP \fBSoEvent\fP * SoScXMLEvent::getSoEvent (\fBvoid\fP) const\fC [virtual]\fP"
Returns the pointer to the stored \fBSoEvent\fP or NULL if no event has been stored yet\&.
.PP
\fBSee also\fP
.RS 4
\fBsetSoEvent\fP 
.RE
.PP

.SS "\fBvoid\fP SoScXMLEvent::setUpIdentifier (\fBvoid\fP)\fC [virtual]\fP"
This method updates the \fBScXMLEvent\fP event class and event identifier strings based on the set \fBSoEvent\fP object\&.
.PP
The identifiers will be cleared if no \fBSoEvent\fP object has been stored\&.
.PP
\fBSee also\fP
.RS 4
\fBsetSoEvent\fP 
.RE
.PP

.SS "\fBvoid\fP SoScXMLEvent::copyContents (\fBconst\fP \fBScXMLEvent\fP * rhs)\fC [virtual]\fP"

.PP
Reimplemented from \fBScXMLEvent\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.