LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XMutableGridDataModel Interface Referencepublished

allows to modify the data represented by a XGridDataModel More...

import"XMutableGridDataModel.idl";

Inheritance diagram for XMutableGridDataModel:
XGridDataModel XComponent XCloneable XInterface XInterface DefaultGridDataModel XSortableMutableGridDataModel SortableGridDataModel

Public Member Functions

void addRow ([in] any Heading, [in] sequence< any > Data)
 appends a row to the model. More...
 
void addRows ([in] sequence< any > Headings, [in] sequence< sequence< any > > Data) raises ( ::com::sun::star::lang::IllegalArgumentException )
 appends multiple rows of data to the model. More...
 
void insertRow ([in] long Index, [in] any Heading, [in] sequence< any > Data) raises ( ::com::sun::star::lang::IndexOutOfBoundsException )
 inserts a row into the set of data rows More...
 
void insertRows ([in] long Index, [in] sequence< any > Headings, [in] sequence< sequence< any > > Data) raises ( ::com::sun::star::lang::IndexOutOfBoundsException , ::com::sun::star::lang::IllegalArgumentException )
 inserts multiple rows of data into the model. More...
 
void removeRow ([in] long RowIndex) raises ( ::com::sun::star::lang::IndexOutOfBoundsException )
 removes a row of data from the model More...
 
void removeAllRows ()
 Removes all rows from the model. More...
 
void updateCellData ([in] long ColumnIndex, [in] long RowIndex, [in] any Value) raises ( ::com::sun::star::lang::IndexOutOfBoundsException )
 updates the content of the given cell More...
 
void updateRowData ([in] sequence< long > ColumnIndexes, [in] long RowIndex, [in] sequence< any > Values) raises ( ::com::sun::star::lang::IndexOutOfBoundsException , ::com::sun::star::lang::IllegalArgumentException)
 updates the content of a given row. More...
 
void updateRowHeading ([in] long RowIndex, [in] any Heading) raises ( ::com::sun::star::lang::IndexOutOfBoundsException )
 sets a new title for a given row. More...
 
void updateCellToolTip ([in] long ColumnIndex, [in] long RowIndex, [in] any Value) raises ( ::com::sun::star::lang::IndexOutOfBoundsException )
 updates the tooltip to be displayed for a given cell More...
 
void updateRowToolTip ([in] long RowIndex, [in] any Value) raises ( ::com::sun::star::lang::IndexOutOfBoundsException )
 updates the tooltip for all cells of a given row More...
 
void addGridDataListener ([in] XGridDataListener Listener)
 registers listener to be notified of data changes in the model More...
 
void removeGridDataListener ([in] XGridDataListener Listener)
 revokes a listener which was previously registered via addGridDataListener() More...
 
- Public Member Functions inherited from XGridDataModel
any getCellData ([in] long Column, [in] long RowIndex) raises ( ::com::sun::star::lang::IndexOutOfBoundsException )
 retrieves the data for a given cell More...
 
any getCellToolTip ([in] long Column, [in] long RowIndex) raises ( ::com::sun::star::lang::IndexOutOfBoundsException )
 retrieves the tool tip to be displayed when the mouse hovers over a given cell More...
 
any getRowHeading ([in] long RowIndex) raises ( ::com::sun::star::lang::IndexOutOfBoundsException )
 retrieves the heading of a given row More...
 
sequence< any > getRowData ([in] long RowIndex) raises ( ::com::sun::star::lang::IndexOutOfBoundsException )
 retrieves the data for a complete row More...
 
- Public Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
 
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
 
void removeEventListener ([in] XEventListener aListener)
 removes an event listener from the listener list. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XCloneable
com::sun::star::util::XCloneable createClone ()
 creates a copy of the object. More...
 

Additional Inherited Members

- Exported Interfaces inherited from XGridDataModel
interface ::com::sun::star::lang::XComponent
 implements life time control for the component More...
 
interface ::com::sun::star::util::XCloneable
 allows cloning the complete data model More...
 
- Public Attributes inherited from XGridDataModel
long RowCount
 denotes the number of rows for which the model can provide data More...
 
long ColumnCount
 denotes the number of columns for which the model can provide data More...
 

Detailed Description

allows to modify the data represented by a XGridDataModel

Member Function Documentation

void addGridDataListener ( [in] XGridDataListener  Listener)

registers listener to be notified of data changes in the model

Parameters
Listenerspecifies the listener to register
void addRow ( [in] any  Heading,
[in] sequence< any >  Data 
)

appends a row to the model.

Parameters
Headingdenotes the heading of the row.
Dataspecifies the content of the row.
void addRows ( [in] sequence< any >  Headings,
[in] sequence< sequence< any > >  Data 
)
raises (::com::sun::star::lang::IllegalArgumentException
)

appends multiple rows of data to the model.

Parameters
Headingsdenotes the headings of the to-be-added rows.
Dataspecifies the data of the rows to be added.
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif Titles and Data are of different length.
void insertRow ( [in] long  Index,
[in] any  Heading,
[in] sequence< any >  Data 
)
raises (::com::sun::star::lang::IndexOutOfBoundsException
)

inserts a row into the set of data rows

Parameters
Indexdenotes the position at which the row is to be inserted
Headingdenotes the heading of the row.
Dataspecifies the content of the row.
Exceptions
com::sun::star::lang::IndexOutOfBoundsExceptionif Index is smaller than 0 or greater than the number of rows in the model.
void insertRows ( [in] long  Index,
[in] sequence< any >  Headings,
[in] sequence< sequence< any > >  Data 
)
raises ( ::com::sun::star::lang::IndexOutOfBoundsException ,
::com::sun::star::lang::IllegalArgumentException
)

inserts multiple rows of data into the model.

Parameters
Indexdenotes the position at which the rows are to be inserted
Headingsdenotes the headings of the to-be-added rows.
Dataspecifies the data of the rows to be added.
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif Titles and Data are of different length.
com::sun::star::lang::IndexOutOfBoundsExceptionif Index is smaller than 0 or greater than the number of rows in the model.
void removeAllRows ( )

Removes all rows from the model.

void removeGridDataListener ( [in] XGridDataListener  Listener)

revokes a listener which was previously registered via addGridDataListener()

Parameters
Listenerspecifies the listener to revoke.
void removeRow ( [in] long  RowIndex)
raises (::com::sun::star::lang::IndexOutOfBoundsException
)

removes a row of data from the model

Parameters
RowIndexthe index of the row that should be removed.
Exceptions
com::sun::star::lang::IndexOutOfBoundsExceptionif the given index is invalid
void updateCellData ( [in] long  ColumnIndex,
[in] long  RowIndex,
[in] any  Value 
)
raises (::com::sun::star::lang::IndexOutOfBoundsException
)

updates the content of the given cell

Parameters
ColumnIndexthe column index of the to-be-updated cell
RowIndexthe row index of the to-be-updated cell
Valuethe new value of the cell.
Exceptions
com::sun::star::lang::IndexOutOfBoundsExceptionif the row or column index is invalid
void updateCellToolTip ( [in] long  ColumnIndex,
[in] long  RowIndex,
[in] any  Value 
)
raises (::com::sun::star::lang::IndexOutOfBoundsException
)

updates the tooltip to be displayed for a given cell

See also
XGridDataModel::getCellToolTip
void updateRowData ( [in] sequence< long >  ColumnIndexes,
[in] long  RowIndex,
[in] sequence< any >  Values 
)
raises ( ::com::sun::star::lang::IndexOutOfBoundsException ,
::com::sun::star::lang::IllegalArgumentException
)

updates the content of a given row.

The change in the data model will be notified to registered listeners via XGridDataListener::dataChanged(). The GridDataEvent::FirstColumn and GridDataEvent::LastColumn will denote the smallest respectively largest column index from ColumnIndexes.

Parameters
ColumnIndexescontains the column indexes of the cells, which should be updated
RowIndexcontains the index of the row whose data is to be updated
Valuesspecifies the new values of the cells.
Exceptions
com::sun::star::lang::IndexOutOfBoundsExceptionif one of the row indexes or the column index is invalid
com::sun::star::lang::IllegalArgumentExceptionif the lengths of the ColumnIndexes and Values sequences are not equal.
void updateRowHeading ( [in] long  RowIndex,
[in] any  Heading 
)
raises (::com::sun::star::lang::IndexOutOfBoundsException
)

sets a new title for a given row.

Exceptions
com::sun::star::lang::IndexOutOfBoundsExceptionif the given index does not denote a valid row.
void updateRowToolTip ( [in] long  RowIndex,
[in] any  Value 
)
raises (::com::sun::star::lang::IndexOutOfBoundsException
)

updates the tooltip for all cells of a given row

Effectively this method is a shortcut for calling updateCellToolTip() multiple times in a row, for all cells of a given row.

See also
XGridDataModel::getCellToolTip
updateCellToolTip

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