Detailed Description

Spreadsheet that contain data of the table explorer editor.

Inheritance diagram for Doloro.DataManagement.Tables.Spreadsheet:

[legend]

Collaboration diagram for Doloro.DataManagement.Tables.Spreadsheet:

[legend]

Public Member Functions
	Spreadsheet ()
	Empty constructor.

	Spreadsheet (SerializationInfo info, StreamingContext context)
	Allows to binary serializer instantiate the object from binary. More...

	Spreadsheet (string dataPath)
	Creates spreadsheet instance bonded with a data resource by path. More...

	Spreadsheet (Table data)
	Creates spreadsheet for RAM located data tables. More...

void	SetContentDirty ()
	Marks spreadsheet's content data as modified.

void	Dispose ()
	Releases binded table allocation.

float	GetColumnSize (int idx)
	Returns size defined for certain column. More...

float	GetRawColumnSize (int idx)
	Returns raw size defined for certain column. More...

void	SetColumnSize (int idx, float size)
	Sets size of certain column. More...

float	GetRowSize (int idx)
	Returns size defined for certain row. More...

float	GetRawRowSize (int idx)
	Returns raw size defined for certain row. More...

void	SetRowSize (int idx, float size)
	Sets size of certain raw. More...

void	DropRowSize (int idx)
	Drops row's size to default. More...

void	DropColumnSize (int idx)
	Drops column's size to default. More...

void	SetColumnTitle (int idx, string content)
	Applies the title to the column by index. More...

void	SetColumnTitle (int idx, GUIContent content)
	Applies the title to the column by index. More...

void	SetRowTitle (int idx, string content)
	Applies the title to the row by index. More...

void	SetRowTitle (int idx, GUIContent content)
	Applies the title to the row by index. More...

bool	HasCustomRowTitle (int idx)
	Checks is the custom title for the row is registered. More...

bool	HasCustomColumnTitle (int idx)
	Checks is the custom title for the column is registered. More...

GUIContent	GetRowTitle (int idx)
	Returns title defined for the row. More...

GUIContent	GetColumnTitle (int idx)
	Returns title defined for the column. More...

void	DropColumnTitle (int idx)
	Drops column's title to default. More...

void	DropRowTitle (int idx)
	Drops row's title to default. More...

virtual void	GetObjectData (SerializationInfo info, StreamingContext context)
	Converts data object to the binary dump. More...

void	SetDirty ()
	Marks asset as modified and required save operation.

Static Public Attributes
const int	POINT_PER_SCROLL = 1
	How many texels adding per each element.

Protected Member Functions
override void	OnPreSave ()
	Checks that the DataPath not null or whitespace. More...

virtual void	Dispose (bool disposing)
	Releasing data allocated for the spreadsheet. More...

virtual void	OnPostSave ()
	Occurs after save process started.

Properties
new bool	isDirty `[get]`
	Is the asset as modified.

bool	isReadOnly `[get, set]`
	If true then table values will be not editable via the editor.

bool	isClamped `[get, set]`
	If true then editor will show only defined cells avoiding extra ones.

string	DataPath `[get, set]`
	Path to raw data resource. More...

bool	isContentDirty `[get, set]`
	True in case if data table was modified.

bool	isDataLoaded `[get]`
	Is the raw data binded to the spreadsheet was loaded.

Table	source `[get, set]`
	Data set operating by the spreadsheet. More...

int	columnInScope `[get]`
	Column's index of left top cell that in scope.

int	rowInScope `[get]`
	Row's index of left top cell that in scope.

Vector2	offset `[get]`
	Offset in pixels that should be applied to current cell positions layout.

BaseTypes.Color	DefaultCellColor `[get, set]`
	Color of the regular cell's background.

BaseTypes.Color	DefaultServiceCellColor `[get, set]`
	Color of the service cell's background.

BaseTypes.Color	SplitterColor `[get, set]`
	Color of the splitter lines.

BaseTypes.Vector2	DefaultCellSize `[get, set]`
	Size that applying to the cell in case if not overridden.

BaseTypes.Vector2	ScrollPosition `[get, set]`
	Position of the scroll view.

int	LastColumnWithCustomTitle `[get]`
	Higher index of the column with defined title. More...

int	LastRowWithCustomTitle `[get]`
	Higher index of the row with defined title. More...

bool	isRamLocated `[get]`
	Is the object has no binding to the stored resource.

bool	isObsolete `[get]`
	The asset data is no longer relevant. More...

StorableAsset	asset `[get, set]`
	Reference to relevant asset. More...

string	StoredAssetPath `[get, set]`
	Path to resource binded to the instance. More...

Events
Action	AssetObsoleted
	Occurs when object became obsolete.

Constructor & Destructor Documentation

◆ Spreadsheet() [1/3]

Doloro.DataManagement.Tables.Spreadsheet.Spreadsheet	(	SerializationInfo	info,
		StreamingContext	context
	)

Allows to binary serializer instantiate the object from binary.

Parameters

info
context

◆ Spreadsheet() [2/3]

Doloro.DataManagement.Tables.Spreadsheet.Spreadsheet ( string dataPath )

Creates spreadsheet instance bonded with a data resource by path.

Parameters

dataPath Path to serialized Table resource.

◆ Spreadsheet() [3/3]

Doloro.DataManagement.Tables.Spreadsheet.Spreadsheet ( Table data )

Creates spreadsheet for RAM located data tables.

Parameters

data	Table to spreadsheet.

Member Function Documentation

◆ Dispose()

virtual void Doloro.DataManagement.Tables.Spreadsheet.Dispose ( bool disposing )

protectedvirtual

Releasing data allocated for the spreadsheet.

Parameters

disposing

◆ DropColumnSize()

void Doloro.DataManagement.Tables.Spreadsheet.DropColumnSize ( int idx )

Drops column's size to default.

Parameters

idx	Index of the column to drop.

◆ DropColumnTitle()

void Doloro.DataManagement.Tables.Spreadsheet.DropColumnTitle ( int idx )

Drops column's title to default.

Parameters

idx	Index of the column to drop.

◆ DropRowSize()

void Doloro.DataManagement.Tables.Spreadsheet.DropRowSize ( int idx )

Drops row's size to default.

Parameters

idx	Index of the tow to drop.

◆ DropRowTitle()

void Doloro.DataManagement.Tables.Spreadsheet.DropRowTitle ( int idx )

Drops row's title to default.

Parameters

idx	Index of the column to drop.

◆ GetColumnSize()

float Doloro.DataManagement.Tables.Spreadsheet.GetColumnSize ( int idx )

Returns size defined for certain column.

Parameters

idx	Column's index.

Returns: Width of the column along with table's layout.

◆ GetColumnTitle()

GUIContent Doloro.DataManagement.Tables.Spreadsheet.GetColumnTitle ( int idx )

Returns title defined for the column.

Parameters

idx	Index of the column to get.

Returns: Predefined content. Exception in case if not exists.

See also: HasCustomColumnTitle

◆ GetObjectData()

virtual void Doloro.DataManagement.Serialization.StorableAsset.GetObjectData	(	SerializationInfo	info,
		StreamingContext	context
	)

virtualinherited

Converts data object to the binary dump.

Parameters

info
context

◆ GetRawColumnSize()

float Doloro.DataManagement.Tables.Spreadsheet.GetRawColumnSize ( int idx )

Returns raw size defined for certain column.

Parameters

idx	Column's index.

Returns: Fixed width of the column. 0 means stretched.

◆ GetRawRowSize()

float Doloro.DataManagement.Tables.Spreadsheet.GetRawRowSize ( int idx )

Returns raw size defined for certain row.

Parameters

idx	Row's index.

Returns: Fixed height of the row. 0 means stretched.

◆ GetRowSize()

float Doloro.DataManagement.Tables.Spreadsheet.GetRowSize ( int idx )

Returns size defined for certain row.

Parameters

idx	Row's index.

Returns: Height of the row along with table's layout.

◆ GetRowTitle()

GUIContent Doloro.DataManagement.Tables.Spreadsheet.GetRowTitle ( int idx )

Returns title defined for the row.

Parameters

idx	Index of the row to get.

Returns: Predefined content. Exception in case if not exists.

See also: HasCustomRowTitle

◆ HasCustomColumnTitle()

bool Doloro.DataManagement.Tables.Spreadsheet.HasCustomColumnTitle ( int idx )

Checks is the custom title for the column is registered.

Parameters

idx	Index of the column to check.

Returns: Result of title definition check.

◆ HasCustomRowTitle()

bool Doloro.DataManagement.Tables.Spreadsheet.HasCustomRowTitle ( int idx )

Checks is the custom title for the row is registered.

Parameters

idx	Index of the row to check.

Returns: Result of title definition check.

◆ OnPreSave()

override void Doloro.DataManagement.Tables.Spreadsheet.OnPreSave ( )

protectedvirtual

Checks that the DataPath not null or whitespace.

Reimplemented from Doloro.DataManagement.Serialization.StorableAsset.

◆ SetColumnSize()

void Doloro.DataManagement.Tables.Spreadsheet.SetColumnSize	(	int	idx,
		float	size
	)

Sets size of certain column.

Parameters

idx	Column's index.
size	Width of column in pixels. 0 means scratched.

◆ SetColumnTitle() [1/2]

void Doloro.DataManagement.Tables.Spreadsheet.SetColumnTitle	(	int	idx,
		GUIContent	content
	)

Applies the title to the column by index.

Parameters

idx	Index of the column.
content	Content to set.

◆ SetColumnTitle() [2/2]

void Doloro.DataManagement.Tables.Spreadsheet.SetColumnTitle	(	int	idx,
		string	content
	)

Applies the title to the column by index.

Parameters

idx	Index of the column.
content	Content to set.

◆ SetRowSize()

void Doloro.DataManagement.Tables.Spreadsheet.SetRowSize	(	int	idx,
		float	size
	)

Sets size of certain raw.

Parameters

idx	Row's index.
size	Height of row in pixels. 0 means scratched.

◆ SetRowTitle() [1/2]

void Doloro.DataManagement.Tables.Spreadsheet.SetRowTitle	(	int	idx,
		GUIContent	content
	)

Applies the title to the row by index.

Parameters

idx	Index of the row.
content	Content to set.

◆ SetRowTitle() [2/2]

void Doloro.DataManagement.Tables.Spreadsheet.SetRowTitle	(	int	idx,
		string	content
	)

Applies the title to the row by index.

Parameters

idx	Index of the row.
content	Content to set.

Property Documentation

◆ asset

StorableAsset Doloro.DataManagement.Serialization.StorableAsset.asset

getsetprotectedinherited

Reference to relevant asset.

References itself in case if isObsolete is false.

◆ DataPath

string Doloro.DataManagement.Tables.Spreadsheet.DataPath

getset

Path to raw data resource.

Returns source's property Serialization.StorableAsset.StoredAssetPath in case if data loaded. Stored reference otherwise.

◆ isObsolete

bool Doloro.DataManagement.Serialization.StorableAsset.isObsolete

getpackageinherited

The asset data is no longer relevant.

Occurs when object was overridden by some data operation (Load etc.) In this case reference

See also: asset

◆ LastColumnWithCustomTitle

int Doloro.DataManagement.Tables.Spreadsheet.LastColumnWithCustomTitle

get

Higher index of the column with defined title.

-1 in case if there is no defined entities.

◆ LastRowWithCustomTitle

int Doloro.DataManagement.Tables.Spreadsheet.LastRowWithCustomTitle

get

Higher index of the row with defined title.

-1 in case if there is no defined entities.

◆ source

Table Doloro.DataManagement.Tables.Spreadsheet.source

getset

Data set operating by the spreadsheet.

Exceptions

UnreferencedContentException DataPath is null or whitespace.

◆ StoredAssetPath

string Doloro.DataManagement.Serialization.StorableAsset.StoredAssetPath

getsetinherited

Path to resource binded to the instance.

Changes during IO.LoadAs(string), IO.SaveAs(StorableAsset, string) or manual set operation.

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

D:/Work/GitHub/DGDK22/Assets/Tauri Interactive/Doloro-GDK/Doloro-Data-Management/Runtime/Tables/Spreadsheet/Spreadsheet.cs
D:/Work/GitHub/DGDK22/Assets/Tauri Interactive/Doloro-GDK/Doloro-Data-Management/Runtime/Tables/Spreadsheet/SpreadsheetLayout.cs
D:/Work/GitHub/DGDK22/Assets/Tauri Interactive/Doloro-GDK/Doloro-Data-Management/Runtime/Tables/Spreadsheet/SpreadsheetSizes.cs
D:/Work/GitHub/DGDK22/Assets/Tauri Interactive/Doloro-GDK/Doloro-Data-Management/Runtime/Tables/Spreadsheet/SpreadsheetTitles.cs

Detailed Description

Public Member Functions

Static Public Attributes

Protected Member Functions

Properties

Events

Constructor & Destructor Documentation

◆ Spreadsheet() [1/3]

◆ Spreadsheet() [2/3]

◆ Spreadsheet() [3/3]

Member Function Documentation

◆ Dispose()

◆ DropColumnSize()

◆ DropColumnTitle()

◆ DropRowSize()

◆ DropRowTitle()

◆ GetColumnSize()

◆ GetColumnTitle()

◆ GetObjectData()

◆ GetRawColumnSize()

◆ GetRawRowSize()

◆ GetRowSize()

◆ GetRowTitle()

◆ HasCustomColumnTitle()

◆ HasCustomRowTitle()

◆ OnPreSave()

◆ SetColumnSize()

◆ SetColumnTitle() [1/2]

◆ SetColumnTitle() [2/2]

◆ SetRowSize()

◆ SetRowTitle() [1/2]

◆ SetRowTitle() [2/2]

Property Documentation

◆ asset

◆ DataPath

◆ isObsolete

◆ LastColumnWithCustomTitle

◆ LastRowWithCustomTitle

◆ source

◆ StoredAssetPath