QSDK 1.1 Documentation

Q::IndexMarkerEd Struct Reference
[Markup Extended Editing API]

Provides markups. More...

#include <Q/markup.h>

Inheritance diagram for Q::IndexMarkerEd:

List of all members.

Public Types
typedef Com::Ptr< IndexMarkerEd >	PTR
enum	Flags { includesChildren = 1 }
Public Member Functions
virtual Utils::Result	getIndices (const char *name, unsigned int flags, IndexSetEd **) const=0
Static Public Attributes
Com::UUID	IID

---

Detailed Description

Provides markups.

To convert markup names to index sets, the application should subclass this and implement the various methods. This class is used by IndexNodeEd to match logical markup names with real set of indices. Some flags may passed to provide some extra context to the markup.

See also:

IndexNodeEd

---

Member Typedef Documentation

typedef Com::Ptr<IndexMarkerEd> Q::IndexMarkerEd::PTR

A COM pointer to an object of this class Reimplemented in Q::AnimationTargetEd.

---

Member Enumeration Documentation

enum Q::IndexMarkerEd::Flags

Enumeration values: includesChildren  Indicates whether the hierarchy of the marked element should be included or not.

---

Member Function Documentation

virtual Utils::Result Q::IndexMarkerEd::getIndices (  const char *  name, unsigned int  flags, IndexSetEd **  )  const [pure virtual]

Return the set of indices associated with the specified markup name and the specified flags. Parameters: name  The name of the markup. flags  Flags to provide some extra context to the markup. Note: If the implementation creates the IndexSetEd component and passes it back to the pointer pointer, it has to make sure its reference count is one. If it passes back a reference on an already created Entity component, it must increase its reference count by one. For more details, read the COM FAQ.

---

Member Data Documentation

Com::UUID Q::IndexMarkerEd::IID [static]

COM IID Reimplemented from Com::Unknown. Reimplemented in Q::AnimationTargetEd.

		Qube Software Limited © 2000-2004