FBNote Class Reference
Detailed Description
Note class.
Inheritance diagram for FBNote:
Public Member Functions |
|
| __init__ (str pName, object pObject=None) | |
| Constructor. |
|
| IQuery_Declare (Implementation) | |
| bool | Attach (HFBComponent pComp=None) |
| Attach the note to a component. |
|
| bool | Detach (HFBComponent pComp=None) |
| Detach the note from a component. |
|
Public Attributes |
|
| FBPropertyString | StaticComment |
| Read Write Property: Comment
associated to this note. |
|
Member Function Documentation
Constructor.
- Parameters:
-
pName Name of note. pObject For internal use only(default=NULL).
Reimplemented from FBBox.
| IQuery_Declare | ( | Implementation | ) |
| bool Attach | ( | HFBComponent | pComp = None |
) |
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.
| bool Detach | ( | HFBComponent | pComp = None |
) |
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.
