The interface to a section in the object model. More...

#include <doxmlintf.h>

Inheritance diagram for ISection:

Public Types
enum	SectionKind { Invalid =0, UserDefined, PubTypes, PubFuncs, PubAttribs, PubSlots, Signals, DCOPFuncs, Properties, Events, PubStatFuncs, PubStatAttribs, ProTypes, ProFuncs, ProAttribs, ProSlots, ProStatFuncs, ProStatAttribs, PacTypes, PacFuncs, PacAttribs, PacStatFuncs, PacStatAttribs, PriTypes, PriFuncs, PriAttribs, PriSlots, PriStatFuncs, PriStatAttribs, Friend, Related, Defines, Prototypes, Typedefs, Enums, Functions, Variables, Invalid =0, UserDefined, PubTypes, PubFuncs, PubAttribs, PubSlots, Signals, DCOPFuncs, Properties, Events, PubStatFuncs, PubStatAttribs, ProTypes, ProFuncs, ProAttribs, ProSlots, ProStatFuncs, ProStatAttribs, PacTypes, PacFuncs, PacAttribs, PacStatFuncs, PacStatAttribs, PriTypes, PriFuncs, PriAttribs, PriSlots, PriStatFuncs, PriStatAttribs, Friend, Related, Defines, Prototypes, Typedefs, Enums, Functions, Variables }

enum	SectionKind { Invalid =0, UserDefined, PubTypes, PubFuncs, PubAttribs, PubSlots, Signals, DCOPFuncs, Properties, Events, PubStatFuncs, PubStatAttribs, ProTypes, ProFuncs, ProAttribs, ProSlots, ProStatFuncs, ProStatAttribs, PacTypes, PacFuncs, PacAttribs, PacStatFuncs, PacStatAttribs, PriTypes, PriFuncs, PriAttribs, PriSlots, PriStatFuncs, PriStatAttribs, Friend, Related, Defines, Prototypes, Typedefs, Enums, Functions, Variables, Invalid =0, UserDefined, PubTypes, PubFuncs, PubAttribs, PubSlots, Signals, DCOPFuncs, Properties, Events, PubStatFuncs, PubStatAttribs, ProTypes, ProFuncs, ProAttribs, ProSlots, ProStatFuncs, ProStatAttribs, PacTypes, PacFuncs, PacAttribs, PacStatFuncs, PacStatAttribs, PriTypes, PriFuncs, PriAttribs, PriSlots, PriStatFuncs, PriStatAttribs, Friend, Related, Defines, Prototypes, Typedefs, Enums, Functions, Variables }

Public Member Functions
virtual const IString *	kindString () const =0

virtual SectionKind	kind () const =0

virtual IDocRoot *	description () const =0

virtual IMemberIterator *	members () const =0

virtual bool	isStatic () const =0

virtual bool	isPublic () const =0

virtual bool	isPrivate () const =0

virtual bool	isProtected () const =0

virtual const IString *	kindString () const =0

virtual SectionKind	kind () const =0

virtual IDocRoot *	description () const =0

virtual IMemberIterator *	members () const =0

virtual bool	isStatic () const =0

virtual bool	isPublic () const =0

virtual bool	isPrivate () const =0

virtual bool	isProtected () const =0

Detailed Description

The interface to a section in the object model.

A compound can have a number of sections, where each section contains a set of members with the properties implied by the section kind. The kind() method returns the kind of the section. The members of the section can be accessed via members(). Apart from using kind(), some of the individual properties of the section can also be inspected via isStatic(), isPublic(), isProtected() and isPrivate().

Definition at line 747 of file doxmlintf.h.

Member Enumeration Documentation

enum ISection::SectionKind

Possible section types

Enumerator
Invalid
UserDefined	A user defined member group.
PubTypes	Public member typedefs.
PubFuncs	Public member functions.
PubAttribs	Public member attributes.
PubSlots	Public Qt Slots.
Signals	Qt Signals.
DCOPFuncs	KDE-DCOP interface functions.
Properties	IDL properties.
Events	C# events.
PubStatFuncs	Public static member functions.
PubStatAttribs	Public static attributes.
ProTypes	Protected member typedefs.
ProFuncs	Protected member functions.
ProAttribs	Protected member attributes.
ProSlots	Protected slots.
ProStatFuncs	Protected static member functions.
ProStatAttribs	Protected static member attributes.
PacTypes	Package member typedefs.
PacFuncs	Package member functions.
PacAttribs	Package member attributes.
PacStatFuncs	Package static member functions.
PacStatAttribs	Package static member attributes.
PriTypes	Private member typedefs.
PriFuncs	Private member functions.
PriAttribs	Private member attributes.
PriSlots	Private Qt slots.
PriStatFuncs	Private static member functions.
PriStatAttribs	Private static member attributes.
Friend	Friends.
Related	Function marked as related.
Defines	Preprocessor defines.
Prototypes	Global function prototypes.
Typedefs	Global typedefs.
Enums	Enumerations.
Functions	Global functions.
Variables	Global variables.
Invalid
UserDefined	A user defined member group.
PubTypes	Public member typedefs.
PubFuncs	Public member functions.
PubAttribs	Public member attributes.
PubSlots	Public Qt Slots.
Signals	Qt Signals.
DCOPFuncs	KDE-DCOP interface functions.
Properties	IDL properties.
Events	C# events.
PubStatFuncs	Public static member functions.
PubStatAttribs	Public static attributes.
ProTypes	Protected member typedefs.
ProFuncs	Protected member functions.
ProAttribs	Protected member attributes.
ProSlots	Protected slots.
ProStatFuncs	Protected static member functions.
ProStatAttribs	Protected static member attributes.
PacTypes	Package member typedefs.
PacFuncs	Package member functions.
PacAttribs	Package member attributes.
PacStatFuncs	Package static member functions.
PacStatAttribs	Package static member attributes.
PriTypes	Private member typedefs.
PriFuncs	Private member functions.
PriAttribs	Private member attributes.
PriSlots	Private Qt slots.
PriStatFuncs	Private static member functions.
PriStatAttribs	Private static member attributes.
Friend	Friends.
Related	Function marked as related.
Defines	Preprocessor defines.
Prototypes	Global function prototypes.
Typedefs	Global typedefs.
Enums	Enumerations.
Functions	Global functions.
Variables	Global variables.

Definition at line 752 of file doxmlintf.h.

     { Invalid=0,
       UserDefined,         //!< A user defined member group 
       PubTypes,            //!< Public member typedefs
       PubFuncs,            //!< Public member functions
       PubAttribs,          //!< Public member attributes 
       PubSlots,            //!< Public Qt Slots
       Signals,             //!< Qt Signals
       DCOPFuncs,           //!< KDE-DCOP interface functions
       Properties,          //!< IDL properties
       Events,              //!< C# events
       PubStatFuncs,        //!< Public static member functions
       PubStatAttribs,      //!< Public static attributes
       ProTypes,            //!< Protected member typedefs
       ProFuncs,            //!< Protected member functions
       ProAttribs,          //!< Protected member attributes
       ProSlots,            //!< Protected slots
       ProStatFuncs,        //!< Protected static member functions
       ProStatAttribs,      //!< Protected static member attributes
       PacTypes,            //!< Package member typedefs
       PacFuncs,            //!< Package member functions
       PacAttribs,          //!< Package member attributes
       PacStatFuncs,        //!< Package static member functions
       PacStatAttribs,      //!< Package static member attributes
       PriTypes,            //!< Private member typedefs
       PriFuncs,            //!< Private member functions
       PriAttribs,          //!< Private member attributes
       PriSlots,            //!< Private Qt slots
       PriStatFuncs,        //!< Private static member functions
       PriStatAttribs,      //!< Private static member attributes
       Friend,              //!< Friends
       Related,             //!< Function marked as related
       Defines,             //!< Preprocessor defines
       Prototypes,          //!< Global function prototypes
       Typedefs,            //!< Global typedefs
       Enums,               //!< Enumerations
       Functions,           //!< Global functions
       Variables            //!< Global variables
     };

enum ISection::SectionKind

Possible section types

Enumerator
Invalid
UserDefined	A user defined member group.
PubTypes	Public member typedefs.
PubFuncs	Public member functions.
PubAttribs	Public member attributes.
PubSlots	Public Qt Slots.
Signals	Qt Signals.
DCOPFuncs	KDE-DCOP interface functions.
Properties	IDL properties.
Events	C# events.
PubStatFuncs	Public static member functions.
PubStatAttribs	Public static attributes.
ProTypes	Protected member typedefs.
ProFuncs	Protected member functions.
ProAttribs	Protected member attributes.
ProSlots	Protected slots.
ProStatFuncs	Protected static member functions.
ProStatAttribs	Protected static member attributes.
PacTypes	Package member typedefs.
PacFuncs	Package member functions.
PacAttribs	Package member attributes.
PacStatFuncs	Package static member functions.
PacStatAttribs	Package static member attributes.
PriTypes	Private member typedefs.
PriFuncs	Private member functions.
PriAttribs	Private member attributes.
PriSlots	Private Qt slots.
PriStatFuncs	Private static member functions.
PriStatAttribs	Private static member attributes.
Friend	Friends.
Related	Function marked as related.
Defines	Preprocessor defines.
Prototypes	Global function prototypes.
Typedefs	Global typedefs.
Enums	Enumerations.
Functions	Global functions.
Variables	Global variables.
Invalid
UserDefined	A user defined member group.
PubTypes	Public member typedefs.
PubFuncs	Public member functions.
PubAttribs	Public member attributes.
PubSlots	Public Qt Slots.
Signals	Qt Signals.
DCOPFuncs	KDE-DCOP interface functions.
Properties	IDL properties.
Events	C# events.
PubStatFuncs	Public static member functions.
PubStatAttribs	Public static attributes.
ProTypes	Protected member typedefs.
ProFuncs	Protected member functions.
ProAttribs	Protected member attributes.
ProSlots	Protected slots.
ProStatFuncs	Protected static member functions.
ProStatAttribs	Protected static member attributes.
PacTypes	Package member typedefs.
PacFuncs	Package member functions.
PacAttribs	Package member attributes.
PacStatFuncs	Package static member functions.
PacStatAttribs	Package static member attributes.
PriTypes	Private member typedefs.
PriFuncs	Private member functions.
PriAttribs	Private member attributes.
PriSlots	Private Qt slots.
PriStatFuncs	Private static member functions.
PriStatAttribs	Private static member attributes.
Friend	Friends.
Related	Function marked as related.
Defines	Preprocessor defines.
Prototypes	Global function prototypes.
Typedefs	Global typedefs.
Enums	Enumerations.
Functions	Global functions.
Variables	Global variables.

Definition at line 752 of file doxmlintf.h.

     { Invalid=0,
       UserDefined,         //!< A user defined member group 
       PubTypes,            //!< Public member typedefs
       PubFuncs,            //!< Public member functions
       PubAttribs,          //!< Public member attributes 
       PubSlots,            //!< Public Qt Slots
       Signals,             //!< Qt Signals
       DCOPFuncs,           //!< KDE-DCOP interface functions
       Properties,          //!< IDL properties
       Events,              //!< C# events
       PubStatFuncs,        //!< Public static member functions
       PubStatAttribs,      //!< Public static attributes
       ProTypes,            //!< Protected member typedefs
       ProFuncs,            //!< Protected member functions
       ProAttribs,          //!< Protected member attributes
       ProSlots,            //!< Protected slots
       ProStatFuncs,        //!< Protected static member functions
       ProStatAttribs,      //!< Protected static member attributes
       PacTypes,            //!< Package member typedefs
       PacFuncs,            //!< Package member functions
       PacAttribs,          //!< Package member attributes
       PacStatFuncs,        //!< Package static member functions
       PacStatAttribs,      //!< Package static member attributes
       PriTypes,            //!< Private member typedefs
       PriFuncs,            //!< Private member functions
       PriAttribs,          //!< Private member attributes
       PriSlots,            //!< Private Qt slots
       PriStatFuncs,        //!< Private static member functions
       PriStatAttribs,      //!< Private static member attributes
       Friend,              //!< Friends
       Related,             //!< Function marked as related
       Defines,             //!< Preprocessor defines
       Prototypes,          //!< Global function prototypes
       Typedefs,            //!< Global typedefs
       Enums,               //!< Enumerations
       Functions,           //!< Global functions
       Variables            //!< Global variables
     };

Member Function Documentation

virtual IDocRoot* ISection::description ( ) const

pure virtual

Returns the description attached to this section (for user defined sections, also known as member groups).

Implemented in SectionHandler.

virtual IDocRoot* ISection::description ( ) const

pure virtual

Returns the description attached to this section (for user defined sections, also known as member groups).

Implemented in SectionHandler.

virtual bool ISection::isPrivate ( ) const

pure virtual

Returns true if this section belongs to a private section of a class

Implemented in SectionHandler.

virtual bool ISection::isPrivate ( ) const

pure virtual

Returns true if this section belongs to a private section of a class

Implemented in SectionHandler.

virtual bool ISection::isProtected ( ) const

pure virtual

Returns true if this section belongs to a protected section of a class

Implemented in SectionHandler.

virtual bool ISection::isProtected ( ) const

pure virtual

Returns true if this section belongs to a protected section of a class

Implemented in SectionHandler.

virtual bool ISection::isPublic ( ) const

pure virtual

Returns true if this section belongs to a public section of a class

Implemented in SectionHandler.

virtual bool ISection::isPublic ( ) const

pure virtual

Returns true if this section belongs to a public section of a class

Implemented in SectionHandler.

virtual bool ISection::isStatic ( ) const

pure virtual

Returns true if this section contains statics

Implemented in SectionHandler.

virtual bool ISection::isStatic ( ) const

pure virtual

Returns true if this section contains statics

Implemented in SectionHandler.

virtual SectionKind ISection::kind ( ) const

pure virtual

Returns what kind of section this is

Implemented in SectionHandler.

virtual SectionKind ISection::kind ( ) const

pure virtual

Returns what kind of section this is

Implemented in SectionHandler.

virtual const IString* ISection::kindString ( ) const

pure virtual

Returns a string representation of the value returned by kind()

Implemented in SectionHandler.

virtual const IString* ISection::kindString ( ) const

pure virtual

Returns a string representation of the value returned by kind()

Implemented in SectionHandler.

virtual IMemberIterator* ISection::members ( ) const

pure virtual

Returns an iterator for the members of this section

Implemented in SectionHandler.

virtual IMemberIterator* ISection::members ( ) const

pure virtual

Returns an iterator for the members of this section

Implemented in SectionHandler.

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

doxygen-1.8.11/addon/doxmlparser/include/doxmlintf.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation