Public Member Functions | Public Attributes

FBNote Class Reference

Search for all occurrences

Detailed Description

Note class.

Definition at line 66 of file fbnote.h.

#include <fbnote.h>

Inheritance diagram for FBNote:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBNote (const char *pName, HIObject pObject=NULL)
 Constructor.
 IQuery_Declare (K_IMPLEMENTATION)
virtual bool Attach (FBComponent *pComp=NULL)
 Attach the note to a component.
virtual bool Detach (FBComponent *pComp=NULL)
 Detach the note from a component.

Public Attributes

FBPropertyString StaticComment
 Read Write Property: Comment associated to this note.

Constructor & Destructor Documentation

FBNote ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pNameName of note.
pObjectFor internal use only(default=NULL).

Member Function Documentation

IQuery_Declare ( K_IMPLEMENTATION  )
virtual bool Attach ( FBComponent pComp = NULL) [virtual]

Attach the note to a component.

Will attach the note to the component. If pComp is NULL, the note will only be added to the scene.

Parameters:
pCompComponent on which to attach note.
Returns:
A boolean indicating if the operation was successful or not.
virtual bool Detach ( FBComponent pComp = NULL) [virtual]

Detach the note from a component.

Will detach the note from the component. If pComp is NULL, the note will be removed from the scene and detached from all components.

Parameters:
pCompComponent from which to detach note.
Returns:
A boolean indicating if the operation was successful or not.

Member Data Documentation

Read Write Property: Comment associated to this note.

Definition at line 97 of file fbnote.h.


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

FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote
FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote