diff options
Diffstat (limited to 'offapi/com/sun/star/awt/grid/XGridDataModel.idl')
| -rw-r--r-- | offapi/com/sun/star/awt/grid/XGridDataModel.idl | 94 |
1 files changed, 33 insertions, 61 deletions
diff --git a/offapi/com/sun/star/awt/grid/XGridDataModel.idl b/offapi/com/sun/star/awt/grid/XGridDataModel.idl index 5cc4085807e1..1ff15e1310e0 100644 --- a/offapi/com/sun/star/awt/grid/XGridDataModel.idl +++ b/offapi/com/sun/star/awt/grid/XGridDataModel.idl @@ -30,8 +30,9 @@ #include <com/sun/star/lang/XComponent.idl> +#include <com/sun/star/util/XCloneable.idl> #include <com/sun/star/awt/grid/XGridDataListener.idl> - +#include <com/sun/star/lang/IndexOutOfBoundsException.idl> //============================================================================= @@ -45,86 +46,57 @@ module com { module sun { module star { module awt { module grid { @since OOo 3.3.0 */ -interface XGridDataModel: ::com::sun::star::lang::XComponent +interface XGridDataModel { - /** Specifies the height of each row. - */ - [attribute] long RowHeight; - - /** Contains the row header. + /** implements life time control for the component */ - [attribute] sequence< string > RowHeaders; + interface ::com::sun::star::lang::XComponent; - /** Returns the content of each row. + /** allows cloning the complete column model */ - [attribute,readonly] sequence< sequence< any > > Data; + interface ::com::sun::star::util::XCloneable; - /**Specifies the width of row header. + /** denotes the number of rows for which the model can provide data */ - [attribute] long RowHeaderWidth; + [attribute, readonly] long RowCount; - /** Returns the number of rows in in the model. - @returns - the number of rows. + /** denotes the number of columns for which the model can provide data */ - long getRowCount(); + [attribute, readonly] long ColumnCount; - /** Adds a row to the model. + /** retrieves the data for a given cell - @param headername - specifies the name of the row. - @param data - the content of the row. + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if the column or row index do not denote a valid cell position. */ - void addRow( [in] string headername, [in] sequence< any > data ); + any getCellData( [in] long Column, [in] long Row ) + raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); - /** Removes a row from the model. + /** retrieves the tool tip to be displayed when the mouse hovers over a given cell - @param index - the index of the row that should be removed. - */ - void removeRow( [in] long index); + <p>At the moment, only string tool tips are supported.</p> - /** Removes all rows from the model. - */ - void removeAll(); - - /**Updates the content of a given cell. - @param row - the row index - @param column - the column index - @param value - the new value of the cell. - */ - void updateCell([in] long row, [in] long column, [in] any value ); - - /**Updates the content of a given row. - @param row - the row index - @param columns - column indexes of the cells, which should be updated - @param value - the new values of the cells. + <p>If <VOID/> is returned here, the cell's content will be displayed as tip, but only if it does + not fit into the cell.</p> + + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if the column or row index do not denote a valid cell position. */ - void updateRow([in] long row, [in] sequence< long > columns, [in] sequence< any > values); + any getCellToolTip( [in] long Column, [in] long Row ) + raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); - //------------------------------------------------------------------------- + /** retrieves the heading of a given row - /** Adds a listener for the <type>GridDataEvent</type> posted after the grid changes. - @param Listener - the listener to add. - */ - [oneway] void addDataListener( [in] XGridDataListener listener); + <p>A grid control will usually paint a row's title in the header column of the respective row.</p> - //------------------------------------------------------------------------- + <p>At the moment, only strings are supported as row headings.</p> - /** Removes a listener previously added with <method>addDataListener()</method>. - @param Listener - the listener to remove. + @throws ::com::sun::star::lang::IndexOutOfBoundsException + if the given index does not denote a valid row. */ - [oneway] void removeDataListener( [in] XGridDataListener listener); - + any + getRowHeading( [in] long RowIndex ) + raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); }; //============================================================================= |