Spreadsheet row. More...

#include <pyfbsdk.h>

Inheritance diagram for FBSpreadRow:

[legend]

Public Member Functions
	FBSpreadRow (FBSpread pParent, kReference pRow)
	Constructor.

bool	EditCaption ()
	Edit the row caption.

	Remove ()
	Remove (destroy) row.

Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.

str	ClassName ()
	Get the class name.

	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

bool	FBCreate ()
	Open Reality Creation function.

	FBDelete ()
	Open Reality deletion function.

	FBDestroy ()
	Open Reality destruction function.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.

	HardSelect ()
	HardSelect.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

bool	Is (int pTypeId)
	Returns true if object is of type TypeId.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.

int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.

bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.

FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.

	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.

	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Public Attributes
str	Caption
	Read Write Property: Caption to display with row.

FBkReference	Parent
	Read Write Property: Parent of row (reference).

bool	RowSelected
	Read Write Property: Is row selected?

bool	RowVisible
	Read Write Property: Is row visible? Set to true to show the row, false to hide the row.

Public Attributes inherited from FBSpreadPart
int	Column
	Read Only Property: Column number.

bool	Enabled
	Read Write Property: Is SpreadPart enabled?

FBTextJustify	Justify
	Read Write Property: Text justification for SpreadPart

bool	ReadOnly
	Read Write Property: Is SpreadPart read-only?

int	Row
	Read Only Property: Row number.

FBCellStyle	Style
	Read Write Property: Style of cell

Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.

str	LongName
	Read Write Property: Name and namespace for object.

str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.

FBListComponent	Parents
	List: Parents.

FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

bool	Selected
	Read Write Property: Selected property.

int	TypeInfo
	Contains the Type information of the object.

Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.

int	TypeInfo
	TypeInfo.

Detailed Description

Spreadsheet row.

Constructor & Destructor Documentation

◆ FBSpreadRow()

FBSpreadRow	(	FBSpread	pParent,
		kReference	pRow
	)

Constructor.

Parameters

pParent	Parent spreadsheet.
pRow	User-defined reference to assign to row.

Member Function Documentation

◆ EditCaption()

bool EditCaption ( )

Edit the row caption.

This will initiate the UI edit of a row caption.

Returns: Operation was successful (true or false).

◆ Remove()

Remove ( )

Remove (destroy) row.

Member Data Documentation

◆ Caption

str Caption

Read Write Property: Caption to display with row.

◆ Parent

FBkReference Parent

Read Write Property: Parent of row (reference).

◆ RowSelected

bool RowSelected

Read Write Property: Is row selected?

◆ RowVisible

bool RowVisible

Read Write Property: Is row visible? Set to true to show the row, false to hide the row.

Public Member Functions

Public Attributes