FBNote Class Reference

FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote FBNote
Inheritance diagram for FBNote:
Inheritance graph
[legend]

List of all members.


Detailed Description

Note class.

Public Member Functions

  FBNote (str pName)
  Constructor.
bool  Attach (FBComponent pComp=None)
  Attach the note to a component.
bool  Detach (FBComponent pComp=None)
  Detach the note from a component.

Public Attributes

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

Constructor & Destructor Documentation

FBNote ( str  pName  ) 

Constructor.

Parameters:
pName  Name of note.

Member Function Documentation

bool Attach ( FBComponent  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 ( FBComponent  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

str StaticComment

Read Write Property: Comment associated to this note.


Generated on Tue Feb 9 19:34:29 2010 for Python Reference Guide by  doxygen 1.5.3