Python Reference Guide
 
Loading...
Searching...
No Matches
FBSpread Class Reference

Base spreadsheet class. More...

#include <pyfbsdk.h>

Inheritance diagram for FBSpread:

Public Member Functions

object GetCellValue (int pRow, int pColumn)
 Get a cell's value.
 
void SetCellValue (int pRow, int pColumn, object pValue)
 Set a cell's value.
 
FBSpreadCell GetSpreadCell (kReference pRef, int pColumn)
 Get a cell from row and column numbers.
 
 FBSpread ()
 Constructor.
 
 Clear ()
 Clear spreadsheet This function will empty spreadsheet of all its rows, columns and cells.
 
 ColumnAdd (str pString, kReference pRef=0)
 Add a column.
 
 GetCellView (kReference pRef, int pColumn, HIKtView pView)
 Get a cell's internal toolkit view.
 
FBSpreadColumn GetColumn (int pColumn)
 Get a column from a column number.
 
int GetColumnCount ()
 Get the column count.
 
FBSpreadCell GetCurrentCell ()
 Get the current cell.
 
FBSpreadRow GetRow (kReference pRef)
 Get a row from a row reference.
 
int GetRowCount ()
 Get the row count.
 
 Home ()
 Position the vertical scrollbar of the spreadsheet to the top.
 
 RowAdd (str pString, kReference pRef=0)
 Add a row.
 
 RowSort (bool pAscending=True)
 Sort rows.
 
 SetCellView (kReference pRef, int pColumn, HIKtView pView)
 Set a cell's internal toolkit view.
 
- Public Member Functions inherited from FBVisualComponent
 FBVisualComponent ()
 Constructor.
 
bool AddChild (FBVisualComponent pChild, int pId=0)
 Add a child component.
 
FBVisualComponent GetChild (int pId=0)
 Get a child component.
 
QWidget GetQWidgetAddress ()
 Get internal QWidget.
 
bool IsView ()
 Is component a view?
 
 Refresh (bool pNow=False)
 Refresh component.
 
 ViewExpose ()
 Exposed view callback function.
 
 ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
 Input callback function.
 
- 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 for spreadsheet.

 
int Column
 Read Write Property: Current column.

 
bool MultiSelect
 Read Write Property: Can there be multiple selections?

 
FBEvent OnCellChange
 Event: Cell value changed.

 
FBEvent OnColumnClick
 Event: Column clicked.

 
FBEvent OnDragAndDrop
 Event: Drag and drop event.

 
FBEvent OnRowClick
 Event: Row clicked.

 
FBkReference Row
 Read Write Property: Current row.

 
- Public Attributes inherited from FBVisualComponent
str RegionName
 Read Write Property: Region name.
 
int RegionOffsetX
 Read Write Property: Region X offset.
 
int RegionOffsetY
 Read Write Property: Region Y offset.
 
int RegionOffsetWidth
 Read Write Property: Region width offset.
 
int RegionOffsetHeight
 Read Write Property: Region height offset.
 
float RegionRatioX
 Read Write Property: Ratio for X attachment.
 
float RegionRatioY
 Read Write Property: Ratio for Y attachment.
 
float RegionRatioWidth
 Read Write Property: Ratio for Width attachment.
 
float RegionRatioHeight
 Read Write Property: Ratio for Height attachment.

 
FBAttachType RegionAttachTypeX
 Read Write Property: X Attachment type.
 
FBAttachType RegionAttachTypeY
 Read Write Property: Y Attachment type.
 
FBAttachType RegionAttachTypeWidth
 Read Write Property: Width Attachment type.
 
FBAttachType RegionAttachTypeHeight
 Read Write Property: Height Attachment type.
 
FBVisualComponent RegionAttachToX
 Read Write Property X Attachment source.
 
FBVisualComponent RegionAttachToY
 Read Write Property: Y Attachment source.
 
FBVisualComponent RegionAttachToWidth
 Read Write Property: Width Attachment source.
 
FBVisualComponent RegionAttachToHeight
 Read Write Property: Height Attachment source.

 
int RegionPosMaxX
 Read Write Property: Region X position Max
 
int RegionPosMinX
 Read Write Property: Region X position Min
 
int RegionPosMaxY
 Read Write Property: Region Y position Max
 
int RegionPosMinY
 Read Write Property: Region Y position Min
 
str BorderCaption
 Read Write Property: Caption to display in border.
 
bool BorderShowCaption
 Read Write Property: Show caption?
 
FBBorderStyle BorderStyle
 Read Write Property: Style of border.
 
bool BorderInSet
 Read Write Property: Is border inset?
 
int BorderWidth
 Read Write Property: Width of border.
 
int BorderSpacing
 Read Write Property: Spacing of border.
 
float BorderMaxAngle
 Read Write Property: Max angle for rounding.
 
int BorderCornerRadius
 Read Write Property: Corner radius (rounded).

 
str Caption
 Property: Widget caption.

 
bool Enabled
 Read Write Property: Is visual enabled?

 
int Height
 Read Write Property: Height.

 
str Hint
 Read Write Property: Hint to show.

 
int Left
 Read Write Property: Left coordinate.

 
bool ReadOnly
 Read Write Property: Is visual component read only?

 
int Top
 Read Write Property: Top coordinate.

 
bool Visible
 Read Write Property: Is visual component visible?

 
int Width
 Read Write Property: Width.

 
- 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

Constructor & Destructor Documentation

◆ FBSpread()

FBSpread ( )

Constructor.

Member Function Documentation

◆ Clear()

Clear ( )

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

◆ ColumnAdd()

ColumnAdd ( str  pString,
kReference  pRef = 0 
)

Add a column.

By default, the newly created column will use the FBCellStyle.kFBCellStyleString style. Modify the Style property to modify the column's style.

Parameters
pStringText to display with column.
pRefUser-define column reference number(default=0).

◆ GetCellValue()

object GetCellValue ( int  pRow,
int  pColumn 
)

Get a cell's value.

Parameters
pRowRow of cell.
pColumnColumn of cell.
Return values
objectValue of the cell (can be str, int, float or FBTime)

◆ GetCellView()

GetCellView ( kReference  pRef,
int  pColumn,
HIKtView  pView 
)

Get a cell's internal toolkit view.

Parameters
pRefRow of cell.
pColumnColumn of cell.
pViewHandle of view.

◆ GetColumn()

FBSpreadColumn GetColumn ( int  pColumn)

Get a column from a column number.

Parameters
pColumnColumn number.
Returns
A copy of column.

◆ GetColumnCount()

int GetColumnCount ( )

Get the column count.

Returns
The column count.

◆ GetCurrentCell()

FBSpreadCell GetCurrentCell ( )

Get the current cell.

Returns
A copy of the the current cell.

◆ GetRow()

FBSpreadRow GetRow ( kReference  pRef)

Get a row from a row reference.

Parameters
pRefReference to a row.
Returns
A copy of the row.

◆ GetRowCount()

int GetRowCount ( )

Get the row count.

Returns
The row count.

◆ GetSpreadCell()

FBSpreadCell GetSpreadCell ( kReference  pRef,
int  pColumn 
)

Get a cell from row and column numbers.

Parameters
pRefRow reference.
pColumnColumn number.
Returns
A copy of the cell.

◆ Home()

Home ( )

Position the vertical scrollbar of the spreadsheet to the top.

◆ RowAdd()

RowAdd ( str  pString,
kReference  pRef = 0 
)

Add a row.

Parameters
pStringText to display with row.
pRefUser-defined reference for row(default=0).

◆ RowSort()

RowSort ( bool  pAscending = True)

Sort rows.

Parameters
pAscendingIf true, sort ascending.

◆ SetCellValue()

void SetCellValue ( int  pRow,
int  pColumn,
object  pValue 
)

Set a cell's value.

To be effective, the type of pValue must be valid type for the cell's style (see FBSpreadPart.Style). By default, a newly created cell will use its column's style. The default column's style is FBCellStyle.kFBCellStyleString. Modify the Style property to modify the cell's style.

Parameters
pRowRow of cell.
pColumnColumn of cell.
pValueValue of the cell (can be str (single or tuple), int, float or FBTime)

◆ SetCellView()

SetCellView ( kReference  pRef,
int  pColumn,
HIKtView  pView 
)

Set a cell's internal toolkit view.

Parameters
pRefRow of cell.
pColumnColumn of cell.
pViewView to use to set cell's view.

Member Data Documentation

◆ Caption

str Caption

Read Write Property: Caption to display for spreadsheet.

◆ Column

int Column

Read Write Property: Current column.

◆ MultiSelect

bool MultiSelect

Read Write Property: Can there be multiple selections?

◆ OnCellChange

FBEvent OnCellChange

Event: Cell value changed.

◆ OnColumnClick

FBEvent OnColumnClick

Event: Column clicked.

◆ OnDragAndDrop

FBEvent OnDragAndDrop

Event: Drag and drop event.

◆ OnRowClick

FBEvent OnRowClick

Event: Row clicked.

◆ Row

FBkReference Row

Read Write Property: Current row.