SoSFEnum(3IV)

NAME
     SoSFEnum (SoSEnum) - field containing an enumerated value

INHERITS FROM
     SoField > SoSField > SoSFEnum

SYNOPSIS
     typedef SoSFEnum    SoSEnum

          Functions from class SoSFEnum:

     void                SoSEnumSetStr(SoSEnum *this, const char *name)
     SoType              SoSEnumGetClassTypeId()
     void                SoSEnumGetTypeId(const SoSEnum *this)
     int                 SoSEnumGet(const SoSEnum *this)
     void                SoSEnumSet(SoSEnum *this, int newValue)
     int                 SoSEnumIsEq(const SoSEnum *this, const SoSFEnum *f)
     int                 SoSEnumIsNEq(const SoSEnum *this, const SoSFEnum *f)

          Functions from class SoField:

     void                SoSEnumSetIgnored(SoSEnum *this, SbBool ignore)
     SbBool              SoSEnumIsIgnored(const SoSEnum *this)
     SbBool              SoSEnumIsDflt(const SoSEnum *this)
     SbBool              SoSEnumIsOfType(const SoSEnum *this, SoType type)
     SbBool              SoSEnumSetFromStr(SoSEnum *this, const char
                              *valueString)
     void                SoSEnumGetIntoStr(SoSEnum *this, SbString
                              *valueString)
     void                SoSEnumTouch(SoSEnum *this)
     SbBool              SoSEnumConnFromField(SoSEnum *this, SoField
                              *fromField)
     SbBool              SoSEnumConnFrom(SoSEnum *this, SoEngineOutput
                              *fromEngine)
     void                SoSEnumDisconn(SoSEnum *this)
     SbBool              SoSEnumIsConn(const SoSEnum *this)
     SbBool              SoSEnumIsConnFromField(const SoSEnum *this)
     SbBool              SoSEnumGetConnField(const SoSEnum *this, SoField
                              **writingField)
     SbBool              SoSEnumIsConnFromEngine(const SoSEnum *this)
     SbBool              SoSEnumGetConnEngine(const SoSEnum *this,
                              SoEngineOutput **engineOutput)
     void                SoSEnumEnableConn(SoSEnum *this, SbBool flag)
     SbBool              SoSEnumIsConnEnabled(const SoSEnum *this)
     int                 SoSEnumGetForwardConn(const SoSEnum *this,
                              SoFieldList *list)
     SoFieldContainer *  SoSEnumGetContainer(const SoSEnum *this)


DESCRIPTION
     A single-value field that contains an enumerated type value, stored as an
     integer. Nodes that use this field class define mnemonic names for the
     values. These names should be used when setting or testing the values of
     the field, even though the values are treated as integers in the methods.

     SoSFEnums are written to file as a mnemonic enumerated type name. The
     name differs among uses of this field in various node or engine classes.
     See the man pages for specific nodes or engines for the names (e.g.
     SoDrawStyle).

FUNCTIONS
     void                SoSEnumSetStr(SoSEnum *this, const char *name)
          Sets this field to contain the given mnemonic name, passed in as a
          name or string.

     SoType              SoSEnumGetClassTypeId()
     void                SoSEnumGetTypeId(const SoSEnum *this)
          Returns the type for this class or a particular object of this
          class.

     int                 SoSEnumGet(const SoSEnum *this)
          Returns this field's value.

     void                SoSEnumSet(SoSEnum *this, int newValue)
          Sets this field to newValue.

     int                 SoSEnumIsEq(const SoSEnum *this, const SoSFEnum *f)
     int                 SoSEnumIsNEq(const SoSEnum *this, const SoSFEnum *f)
          Returns TRUE if f is of the same type and has the same value as this
          field.


SEE ALSO
     SoField, SoSField, SoMFEnum