#include <mobu-python-api.h>

Class Description

Base spreadsheet class.

Inheritance diagram for FBSpread:

Public Member Functions
	__reduce__ ()

	Clear (FBSpread arg1)
	Clear spreadsheet This function will empty spreadsheet of all its rows, columns and cells. More...

	__init__ (object arg1)
	Constructor. More...

	ColumnAdd (FBSpread arg1, str arg2, object arg3)
	Add a column. More...

object	GetCellView (FBSpread arg1, object arg2, object arg3)
	Get a cell's internal toolkit view. More...

	SetCellValue (FBSpread arg1, object arg2, object arg3, object arg4)

object	GetCellValue (FBSpread arg1, object arg2, object arg3)

object	GetSpreadCell (FBSpread arg1, object arg2, object arg3)

object	GetColumn (FBSpread arg1, object arg2)
	Get a column from a column number. More...

object	GetCurrentCell (FBSpread arg1)
	Get the current cell. More...

object	GetRow (FBSpread arg1, object arg2)
	Get a row from a row reference. More...

	RowAdd (FBSpread arg1, str arg2, object arg3)
	Add a row. More...

	RowSort (FBSpread arg1, object arg2)
	Sort rows. More...

	SetCellView (FBSpread arg1, object arg2, object arg3, FBVisualComponent arg4)
	Set a cell's internal toolkit view. More...

Public Member Functions inherited from FBVisualComponent
	__reduce__ ()

bool	AddChild (FBVisualComponent arg1, FBVisualComponent arg2, object arg3)
	Add a child component. More...

object	GetChild (FBVisualComponent arg1, object arg2)
	Get a child component. More...

bool	IsView (FBVisualComponent arg1)
	Is component a view? More...

	Refresh (FBVisualComponent arg1, object arg2)
	Refresh component. More...

	ViewExpose (FBVisualComponent arg1)
	Exposed view callback function. More...

	ViewInput (FBVisualComponent arg1, object arg2, object arg3, FBInputType arg4, object arg5, object arg6)
	Input callback function. More...

int	GetQWidgetAddress (FBVisualComponent arg1)
	Get internal QWidget. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBComponent
	__reduce__ ()

FBPropertyList	PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
	Get list of properties which have been modified since last loading. More...

str	ClassName (FBComponent arg1)
	Get the class name. More...

	DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Disable a specific Object Flags. More...

	EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Enable a specific Object Flags. More...

bool	FBCreate (FBComponent arg1)
	Open Reality Creation function. More...

	FBDelete (FBComponent arg1)
	Open Reality deletion function. More...

	FBDestroy (FBComponent arg1)
	Open Reality destruction function. More...

FBObjectFlag	GetObjectFlags (FBComponent arg1)
	Get all Object Flags (concatenated). More...

bool	GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
	Check to see if an object status is enabled. More...

bool	HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Check whether a specific object flag is enabled. More...

bool	Is (FBComponent arg1, object arg2)
	Returns true if object is of type TypeId. More...

bool	ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessObjectNamespace. More...

int	PropertyAdd (FBComponent arg1, FBProperty arg2)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
	Add a reference property to the component's property manager. More...

object	PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
	Create user or dynamic property. More...

	PropertyRemove (FBComponent arg1, FBProperty arg2)
	Remove a Property from the component's Property manager. More...

	SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	SetObjectFlags. More...

	SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
	Enable/Disable a specific Object Status. More...

	HardSelect (FBComponent arg1)
	HardSelect. More...

object	GetOwnerFileReference (FBComponent arg1)
	Get the owner FileReference object. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBPlug
	__reduce__ ()

bool	BeginChange (FBPlug arg1)
	Begins a change on multiple plugs. More...

str	ClassName (FBPlug arg1)
	internal System vars. More...

bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...

bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...

bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...

bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...

	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...

	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...

bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...

bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...

bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...

	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...

object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...

int	GetDstCount (FBPlug arg1)
	Get destination connection count. More...

FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...

object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...

int	GetOwnedCount (FBPlug arg1)
	Get the owned plug count. More...

object	GetOwner (FBPlug arg1)
	Get the owner of this plug. More...

object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...

int	GetSrcCount (FBPlug arg1)
	Get source connection count. More...

FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...

bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...

bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...

	MoveSrcAt (...)

bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...

bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...

	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...

	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...

	__init__ (...)

method	staticmethod (function)

Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()

	__init__ (...)

Public Attributes
ORSDK2018::FBPropertyString	Caption
	Read Write Property: Caption to display for spreadsheet. More...

FBPropertyBool	MultiSelect
	Read Write Property: Can there be multiple selections? More...

FBPropertyInt	Column
	Read Write Property: Current column. More...

FBPropertykReference	Row
	Read Write Property: Current row. More...

ORSDK2018::FBPropertyEvent	OnCellChange
	Event: Cell value changed. More...

ORSDK2018::FBPropertyEvent	OnRowClick
	Event: Row clicked. More...

ORSDK2018::FBPropertyEvent	OnDragAndDrop
	Event: Drag and drop event. More...

ORSDK2018::FBPropertyEvent	OnColumnClick
	Event: Column clicked. More...

Public Attributes inherited from FBVisualComponent
ORSDK2018::FBPropertyString	Caption
	Property: Widget caption. More...

FBPropertyBool	Enabled
	Read Write Property: Is visual enabled? More...

ORSDK2018::FBPropertyString	Hint
	Read Write Property: Hint to show. More...

FBPropertyBool	ReadOnly
	Read Write Property: Is visual component read only? More...

FBPropertyBool	Visible
	Read Write Property: Is visual component visible? More...

FBPropertyInt	Left
	Read Write Property: Left coordinate. More...

FBPropertyInt	Top
	Read Write Property: Top coordinate. More...

FBPropertyInt	Width
	Read Write Property: Width. More...

FBPropertyInt	Height
	Read Write Property: Height. More...

object	RegionName

object	RegionOffsetX

object	RegionOffsetY

object	RegionOffsetWidth

object	RegionOffsetHeight

object	RegionRatioX

object	RegionRatioY

object	RegionRatioWidth

object	RegionRatioHeight

object	RegionAttachTypeX

object	RegionAttachTypeY

object	RegionAttachTypeWidth

object	RegionAttachTypeHeight

object	RegionAttachToX

object	RegionAttachToY

object	RegionAttachToWidth

object	RegionAttachToHeight

object	RegionPosMinX

object	RegionPosMaxX

object	RegionPosMinY

object	RegionPosMaxY

object	BorderCaption

object	BorderShowCaption

object	BorderStyle

object	BorderWidth

object	BorderSpacing

object	BorderInSet

object	BorderMaxAngle

object	BorderCornerRadius

Public Attributes inherited from FBComponent
object	OwnerNamespace

ORSDK2018::FBPropertyListComponent	Components
	List: List of components. More...

ORSDK2018::FBPropertyString	Name
	Read Write Property: Unique name of object. More...

ORSDK2018::FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...

object	FullName

ORSDK2018::FBPropertyListComponent	Parents
	List: Parents. More...

ORSDK2018::FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__ ( object arg1 )

Constructor.

Python Docstring:

__init__( (object)arg1) -> None

C++ Signature:

 FBSpread()

See the C++ reference

__reduce__ ( )

Clear ( FBSpread arg1 )

Clear spreadsheet This function will empty spreadsheet of all its rows, columns and cells.

Python Docstring:

Clear( (FBSpread)arg1) -> None

C++ Signature:

void Clear()

See the C++ reference

ColumnAdd	(	FBSpread	arg1,
		str	arg2,
		object	arg3
	)

Add a column.

Python Docstring:

ColumnAdd( (FBSpread)arg1, (str)arg2 [, (object)arg3]) -> None

C++ Signature:

void ColumnAdd(const char * pString, kReference pRef = 0)

Parameters

pString	Text to display with column.
pRef	User-define column reference number(default=0).

See the C++ reference

object GetCellValue	(	FBSpread	arg1,
		object	arg2,
		object	arg3
	)

Python Docstring:

GetCellValue( (FBSpread)arg1, (object)arg2, (object)arg3) -> object

object GetCellView	(	FBSpread	arg1,
		object	arg2,
		object	arg3
	)

Get a cell's internal toolkit view.

Python Docstring:

GetCellView( (FBSpread)arg1, (object)arg2, (object)arg3) -> object

C++ Signature:

void GetCellView(kReference pRef, int pColumn, HIKtView & pView)

Parameters

pRef	Row of cell.
pColumn	Column of cell.

Return values

pView Handle of view.

See the C++ reference

object GetColumn	(	FBSpread	arg1,
		object	arg2
	)

Get a column from a column number.

Python Docstring:

GetColumn( (FBSpread)arg1, (object)arg2) -> object

C++ Signature:

ORSDK2018::FBSpreadColumn GetColumn(int pColumn)

Parameters

pColumn Column number.

Returns: A copy of column.

See the C++ reference

object GetCurrentCell ( FBSpread arg1 )

Get the current cell.

Python Docstring:

GetCurrentCell( (FBSpread)arg1) -> object

C++ Signature:

ORSDK2018::FBSpreadCell GetCurrentCell()

Returns: A copy of the the current cell.

See the C++ reference

object GetRow	(	FBSpread	arg1,
		object	arg2
	)

Get a row from a row reference.

Python Docstring:

GetRow( (FBSpread)arg1, (object)arg2) -> object

C++ Signature:

ORSDK2018::FBSpreadRow GetRow(kReference pRef)

Parameters

pRef	Reference to a row.

Returns: A copy of the row.

See the C++ reference

GetSpreadCell	(	FBSpread	arg1,
		object	arg2,
		object	arg3
	)

Python Docstring:

GetSpreadCell( (FBSpread)arg1, (object)arg2, (object)arg3) -> object

Get a cell from row and column numbers.

Parameters

pRef	Row reference.
pColumn	Column number.

Returns: A copy of the cell.

RowAdd	(	FBSpread	arg1,
		str	arg2,
		object	arg3
	)

Add a row.

Python Docstring:

RowAdd( (FBSpread)arg1, (str)arg2 [, (object)arg3]) -> None

C++ Signature:

void RowAdd(const char * pString, kReference pRef = 0)

Parameters

pString	Text to display with row.
pRef	User-defined reference for row(default=0).

See the C++ reference

RowSort	(	FBSpread	arg1,
		object	arg2
	)

Sort rows.

Python Docstring:

RowSort( (FBSpread)arg1 [, (object)arg2]) -> None

C++ Signature:

void RowSort(bool pAscending = true)

Parameters

pAscending If true, sort ascending.

See the C++ reference

SetCellValue	(	FBSpread	arg1,
		object	arg2,
		object	arg3,
		object	arg4
	)

Python Docstring:

SetCellValue( (FBSpread)arg1, (object)arg2, (object)arg3, (object)arg4) -> None

SetCellView	(	FBSpread	arg1,
		object	arg2,
		object	arg3,
		FBVisualComponent	arg4
	)

Set a cell's internal toolkit view.

Python Docstring:

SetCellView( (FBSpread)arg1, (object)arg2, (object)arg3, (FBVisualComponent)arg4) -> None

C++ Signature:

void SetCellView(kReference pRef, int pColumn, HIKtView pView)

Parameters

pRef	Row of cell.
pColumn	Column of cell.
pView	View to use to set cell's view.

See the C++ reference

Member Data Documentation

ORSDK2018::FBPropertyString Caption

Read Write Property: Caption to display for spreadsheet.

See the C++ reference

FBPropertyInt Column

Read Write Property: Current column.

See the C++ reference

FBPropertyBool MultiSelect

Read Write Property: Can there be multiple selections?

See the C++ reference

ORSDK2018::FBPropertyEvent OnCellChange

Event: Cell value changed.

See the C++ reference

ORSDK2018::FBPropertyEvent OnColumnClick

Event: Column clicked.

See the C++ reference

ORSDK2018::FBPropertyEvent OnDragAndDrop

Event: Drag and drop event.

See the C++ reference

ORSDK2018::FBPropertyEvent OnRowClick

Event: Row clicked.

See the C++ reference

FBPropertykReference Row

Read Write Property: Current row.

See the C++ reference

FBSpread Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation