.TH "ScXMLObject" 3 "Wed May 23 2012" "Version 3.1.3" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ScXMLObject \- 
.PP
Base class for all SCXML objects\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/scxml/ScXMLObject\&.h>\fP
.PP
Inherited by \fBScXMLEvent\fP, \fBScXMLInvoke\fP, and \fBScXMLStateMachine\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual \fBSoType\fP \fBgetTypeId\fP (void) const =0"
.br
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBSoType\fP type) const "
.br
.ti -1c
.RI "void \fBsetXMLAttribute\fP (const char *attribute, const char *value)"
.br
.ti -1c
.RI "const char * \fBgetXMLAttribute\fP (const char *attribute) const "
.br
.ti -1c
.RI "virtual SbBool \fBhandleXMLAttributes\fP (void)"
.br
.ti -1c
.RI "virtual void \fBsetContainer\fP (\fBScXMLObject\fP *container)"
.br
.ti -1c
.RI "\fBScXMLObject\fP * \fBgetContainer\fP (void) const "
.br
.ti -1c
.RI "SbBool \fBisContainedIn\fP (const \fBScXMLObject\fP *object) const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.in -1c
.SS "Static Protected Member Functions"

.in +1c
.ti -1c
.RI "static void \fBregisterClassType\fP (const char *xmlns, const char *classname, \fBSoType\fP type)"
.br
.ti -1c
.RI "static void \fBregisterInvokeClassType\fP (const char *xmlns, const char *targettype, const char *source, \fBSoType\fP type)"
.br
.in -1c
.SH "Detailed Description"
.PP 
Base class for all SCXML objects\&. 

\fBSince:\fP
.RS 4
Coin 3\&.0 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "void ScXMLObject::setXMLAttribute (const char *attribute, const char *value)"
This method associates a value with an attribute name\&. This is used for parameter passing while reading by the SCXML reader, but can be used as a general-purpose attribute dictionary outside of that\&.
.PP
If NULL is passed as the value, the attribute is removed\&. 
.SS "const char * ScXMLObject::getXMLAttribute (const char *attribute) const"
This method returns the string value set for an attribute, or NULL if not set\&. 
.SS "SbBool ScXMLObject::handleXMLAttributes (void)\fC [virtual]\fP"
This method is called when the file reader has set all the XML attributes on the object, and wants the object to handle them and report if the values were ok or if a read error should be produced\&.
.PP
\fBReturns:\fP
.RS 4
TRUE if the attributes are ok, and FALSE on error\&.
.RE
.PP
This base class implementation does nothing and just returns TRUE\&. 
.PP
Reimplemented in \fBScXMLInvoke\fP\&.
.SS "void ScXMLObject::setContainer (\fBScXMLObject\fP *container)\fC [virtual]\fP"
Set the pointer to the parent \fBScXML\fP object\&. 
.SS "SbBool ScXMLObject::isContainedIn (const \fBScXMLObject\fP *object) const"
This method returns TRUE if the object is contained within the given \fIobject\fP argument\&. Also if they are the same, TRUE will be returned\&. Otherwise, FALSE is retured\&. 
.SS "void ScXMLObject::registerClassType (const char *xmlns, const char *classname, \fBSoType\fPtype)\fC [static]\fP, \fC [protected]\fP"
Internal method\&. Friendly forwarding for \fBScXMLObject\fP subclasses\&. 
.SS "void ScXMLObject::registerInvokeClassType (const char *xmlns, const char *targettype, const char *source, \fBSoType\fPtype)\fC [static]\fP, \fC [protected]\fP"
Internal method\&. Friendly forwarding for \fBScXMLObject\fP subclasses\&. 

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