FBNote Class Reference


Detailed Description

Note class.

Inheritance diagram for FBNote:

List of all members.

Public Member Functions

 __init__ (str pName, object pObject=None)
 Constructor.
 IQuery_Declare (K_IMPLEMENTATION)
bool Attach (FBComponent pComp=None)
 Attach the note to a component.
bool Detach (FBComponent pComp=None)
 Detach the note from a component.

Public Attributes

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

Member Function Documentation

__init__ ( str  pName,
object  pObject = None 
)

Constructor.

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

Reimplemented from FBBox.

IQuery_Declare ( K_IMPLEMENTATION  )
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:
pCompComponent 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:
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.


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