Base spreadsheet class. More...

#include <fbcontrols.h>

Inheritance diagram for FBSpread:

[legend]

Public Member Functions
	FBSpread ()
	Constructor.

virtual void	RowAdd (const char *pString, kReference pRef=0)
	Add a row.

virtual void	RowSort (bool pAscending=true)
	Sort rows.

virtual void	ColumnAdd (const char *pString, kReference pRef=0)
	Add a column.

virtual int	GetRowCount ()
	Get the row count.

virtual int	GetColumnCount ()
	Get the column count.

virtual FBSpreadCell	GetCurrentCell ()
	Get the current cell.

virtual FBSpreadCell	GetCell (kReference pRef, int pColumn)
	Get a cell from row and column numbers.

virtual FBSpreadColumn	GetColumn (int pColumn)
	Get a column from a column number.

virtual FBSpreadRow	GetRow (kReference pRef)
	Get a row from a row reference.

virtual void	SetCell (kReference pRef, int pColumn, const char *pString)
	Set a cell's value.

virtual void	SetCell (kReference pRef, int pColumn, int pValue)
	Set a cell's value.

virtual void	SetCell (kReference pRef, int pColumn, kLongLong pValue)

virtual void	SetCell (kReference pRef, int pColumn, double pValue)

virtual void	GetCell (kReference pRef, int pColumn, const char *&pString)
	Get a cell's value.

virtual void	GetCell (kReference pRef, int pColumn, int &pValue)
	Get a cell's value.

virtual void	GetCell (kReference pRef, int pColumn, kLongLong &pValue)

virtual void	GetCell (kReference pRef, int pColumn, double &pValue)

virtual void	SetCellView (kReference pRef, int pColumn, HIKtView pView)
	Set a cell's internal toolkit view.

virtual void	GetCellView (kReference pRef, int pColumn, HIKtView &pView)
	Get a cell's internal toolkit view.

virtual void	Clear ()
	Clear spreadsheet This function will empty spreadsheet of all its rows, columns and cells.

virtual void	Home ()
	Position the vertical scrollbar of the spreadsheet to the top.

Public Member Functions inherited from FBVisualComponent
	FBVisualComponent (HIObject pObject)
	Constructor.

	IObject_Declare (override)

	ICallback_Declare (override)

virtual HIKtView	GetKtView ()
	Get internal toolkit object.

QWidget *	GetQWidgetAddress ()
	Get internal QWidget.

virtual bool	AddChild (FBVisualComponent *pChild, int pId=0)
	Add a child component.

virtual FBVisualComponent *	GetChild (int pId=0)
	Get a child component.

virtual void	Refresh (bool pNow=false)
	Refresh component.

virtual void	ViewExpose ()
	Exposed view callback function.

virtual void	ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
	Input callback function.

virtual bool	IsView ()
	Is component a view?

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor.

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.

virtual 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.

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

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

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.

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

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

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

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

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

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

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.

virtual const char *	ClassName () override
	Get the class name.

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not.

const char *	GetFullName (void)
	Get the full name.

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object.

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object.

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object.

void	HardSelect ()
	HardSelect.

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

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

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

FBPropertykReference	Row
	Read Write Property: Current row.

FBPropertyInt	Column
	Read Write Property: Current column.

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

FBPropertyEvent	OnCellChange
	Event: Cell value changed.

FBPropertyEvent	OnRowClick
	Event: Row clicked.

FBPropertyEvent	OnColumnClick
	Event: Column clicked.

FBPropertyEvent	OnDragAndDrop
	Event: Drag and drop event.

Public Attributes inherited from FBVisualComponent
struct FBVisualComponent::__Region	Region

struct K_DLLEXPORT FBVisualComponent::__Border	Border

FBPropertyString	Caption
	Property: Widget caption.

FBPropertyBool	Visible
	Read Write Property: Is visual component visible?

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

FBPropertyBool	Enabled
	Read Write Property: Is visual enabled?

FBPropertyString	Hint
	Read Write Property: Hint to show.

FBPropertyInt	Left
	Read Write Property: Left coordinate.

FBPropertyInt	Top
	Read Write Property: Top coordinate.

FBPropertyInt	Width
	Read Write Property: Width.

FBPropertyInt	Height
	Read Write Property: Height.

FBPropertyEvent	OnEnter
	Event: On mouse enter.

FBPropertyEvent	OnExit
	Event: On mouse exit.

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

FBPropertyListComponent	Components
	List: List of components.

FBPropertyListComponent	Parents
	List: Parents.

FBPropertyBool	Selected
	Read Write Property: Selected property.

FBPropertyString	Name
	Read Write Property: Unique name of object.

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

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component.

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object.

Protected Member Functions inherited from FBVisualComponent
virtual HIKtObject	GetHIKtObject ()
	Get internal toolkit object.

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component.

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection.

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection.

void	DisconnectAllSrc ()
	Remove all source connections.

void	DisconnectAllDst ()
	Remove all destination connections.

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index.

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index.

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index.

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index.

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B.

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex.

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc.

int	GetSrcCount ()
	Get source connection count.

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index.

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index.

int	GetDstCount ()
	Get destination connection count.

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index.

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index.

bool	BeginChange ()
	Begins a change on multiple plugs.

void	EndChange ()
	Ends a change on multiple plugs.

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag.

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed.

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag.

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed.

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List.

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status.

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag.

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed.

FBPlug *	GetOwner ()
	Get the owner of this plug.

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index.

int	GetOwnedCount ()
	Get the owned plug count.

virtual const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

Base spreadsheet class.

Definition at line 1521 of file fbcontrols.h.

Constructor & Destructor Documentation

◆ FBSpread()

FBSpread ( )

Constructor.

Member Function Documentation

◆ Clear()

virtual void Clear ( )

virtual

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

◆ ColumnAdd()

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

virtual

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

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

◆ GetCell() [1/3]

virtual FBSpreadCell GetCell	(	kReference	pRef,
		int	pColumn
	)

virtual

Get a cell from row and column numbers.

Parameters

pRef	Row reference.
pColumn	Column number.

Returns: A copy of the cell.

◆ GetCell() [2/3]

virtual void GetCell	(	kReference	pRef,
		int	pColumn,
		const char *&	pString
	)

virtual

Get a cell's value.

Parameters

pRef	Row of cell.
pColumn	Column of cell.

Return values

pString String value of cell.

◆ GetCell() [3/3]

virtual void GetCell	(	kReference	pRef,
		int	pColumn,
		int &	pValue
	)

virtual

Get a cell's value.

Parameters

pRef	Row of cell.
pColumn	Column of cell.

Return values

pValue Numeric value of cell.

◆ GetCellView()

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

virtual

Get a cell's internal toolkit view.

Parameters

pRef	Row of cell.
pColumn	Column of cell.

Return values

pView Handle of view.

◆ GetColumn()

virtual FBSpreadColumn GetColumn ( int pColumn )

virtual

Get a column from a column number.

Parameters

pColumn Column number.

Returns: A copy of column.

◆ GetColumnCount()

virtual int GetColumnCount ( )

virtual

Get the column count.

Returns: The column count.

◆ GetCurrentCell()

virtual FBSpreadCell GetCurrentCell ( )

virtual

Get the current cell.

Returns: A copy of the the current cell.

◆ GetRow()

virtual FBSpreadRow GetRow ( kReference pRef )

virtual

Get a row from a row reference.

Parameters

pRef	Reference to a row.

Returns: A copy of the row.

◆ GetRowCount()

virtual int GetRowCount ( )

virtual

Get the row count.

Returns: The row count.

◆ Home()

virtual void Home ( )

virtual

Position the vertical scrollbar of the spreadsheet to the top.

◆ RowAdd()

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

virtual

Add a row.

Parameters

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

◆ RowSort()

virtual void RowSort ( bool pAscending = true )

virtual

Sort rows.

Parameters

pAscending If true, sort ascending.

◆ SetCell() [1/2]

virtual void SetCell	(	kReference	pRef,
		int	pColumn,
		const char *	pString
	)

virtual

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

pRef	Row of cell.
pColumn	Column of cell.
pString	Cell's new value.

◆ SetCell() [2/2]

virtual void SetCell	(	kReference	pRef,
		int	pColumn,
		int	pValue
	)

virtual

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

pRef	Row of cell.
pColumn	Column of cell.
pValue	Cell's new value.

◆ SetCellView()

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

virtual

Set a cell's internal toolkit view.

Parameters

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

Member Data Documentation

◆ Caption

FBPropertyString Caption

Read Write Property: Caption to display for spreadsheet.

Definition at line 1528 of file fbcontrols.h.

◆ Column

FBPropertyInt Column

Read Write Property: Current column.

Definition at line 1530 of file fbcontrols.h.

◆ MultiSelect

FBPropertyBool MultiSelect

Read Write Property: Can there be multiple selections?

Definition at line 1531 of file fbcontrols.h.

◆ OnCellChange

FBPropertyEvent OnCellChange

Event: Cell value changed.

Definition at line 1533 of file fbcontrols.h.

◆ OnColumnClick

FBPropertyEvent OnColumnClick

Event: Column clicked.

Definition at line 1535 of file fbcontrols.h.

◆ OnDragAndDrop

FBPropertyEvent OnDragAndDrop

Event: Drag and drop event.

Definition at line 1536 of file fbcontrols.h.

◆ OnRowClick

FBPropertyEvent OnRowClick

Event: Row clicked.

Definition at line 1534 of file fbcontrols.h.

◆ Row

FBPropertykReference Row

Read Write Property: Current row.

Definition at line 1529 of file fbcontrols.h.

The documentation for this class was generated from the following file:

fbcontrols.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBSpread()

Member Function Documentation

◆ Clear()

◆ ColumnAdd()

◆ GetCell() [1/3]

◆ GetCell() [2/3]

◆ GetCell() [3/3]

◆ GetCellView()

◆ GetColumn()

◆ GetColumnCount()

◆ GetCurrentCell()

◆ GetRow()

◆ GetRowCount()

◆ Home()

◆ RowAdd()

◆ RowSort()

◆ SetCell() [1/2]

◆ SetCell() [2/2]

◆ SetCellView()

Member Data Documentation

◆ Caption

◆ Column

◆ MultiSelect

◆ OnCellChange

◆ OnColumnClick

◆ OnDragAndDrop

◆ OnRowClick

◆ Row