Detailed Description
Note class.
Definition at line 66 of file fbnote.h.
#include <fbnote.h>
List of all
members.
Public Member Functions
|
|
FBNote
(char *pName, HIObject pObject=NULL) |
|
Constructor.
|
|
IQuery_Declare
(Implementation) |
virtual
bool |
Attach
(HFBComponent pComp=NULL) |
|
Attach the note to a component.
|
virtual
bool |
Detach
(HFBComponent pComp=NULL) |
|
Detach the note from a component.
|
Public Attributes
|
FBPropertyString |
StaticComment |
|
Read Write Property: Comment
associated to this note.
|
Constructor & Destructor Documentation
FBNote |
( |
char * |
pName, |
|
|
HIObject |
pObject =
NULL |
|
) |
|
|
Constructor.
- Parameters:
-
pName |
Name of note. |
pObject |
For internal use only(default=NULL). |
Member Function Documentation
IQuery_Declare |
( |
Implementation |
|
) |
|
virtual bool Attach |
( |
HFBComponent |
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:
-
pComp |
Component on which to attach note. |
- Returns:
- A boolean indicating if the operation was successful or
not.
virtual bool Detach |
( |
HFBComponent |
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:
-
pComp |
Component 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: