offapi/com/sun/star/awt/grid/XMutableGridDataModel.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_awt_grid_XMutableGridDataModel_idl__
  29 #define __com_sun_star_awt_grid_XMutableGridDataModel_idl__
  30
  31 #include <com/sun/star/awt/grid/XGridDataModel.idl>
  32 #include <com/sun/star/lang/IllegalArgumentException.idl>
  33 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  34
  35 //==================================================================================================================
  36
  37 module com { module sun { module star { module awt { module grid {
  38
  39 //==================================================================================================================
  40
  41 /** allows to modify the data represented by a <type>XGridDataModel</type>
  42  */
  43 interface XMutableGridDataModel : XGridDataModel
  44 {
  45     /** adds a row to the model.
  46
  47         @param Heading
  48             denotes the heading of the row.
  49         @param Data
  50             specifies the content of the row.
  51     */
  52     void addRow( [in] any Heading, [in] sequence< any > Data );
  53
  54     /** adds multiple rows of data to the model.
  55         @param Headings
  56             denotes the headings of the to-be-added rows.
  57         @param Data
  58             specifies the data of the rows to be added.
  59         @throws ::com::sun::star::lang::IllegalArgumentException
  60             if <code>Titles</code> and <code>Data</code> are of different length.
  61     */
  62     void addRows( [in] sequence< any > Headings, [in] sequence< sequence< any > > Data )
  63         raises ( ::com::sun::star::lang::IllegalArgumentException );
  64
  65     /** removes a row of data from the model
  66
  67         @param RowIndex
  68             the index of the row that should be removed.
  69         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  70             if the given index is invalid
  71     */
  72     void removeRow( [in] long RowIndex )
  73         raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
  74
  75     /** Removes all rows from the model.
  76     */
  77     void removeAllRows();
  78
  79     /** updates the content of the given cell
  80         @param ColumnIndex
  81             the column index of the to-be-updated cell
  82         @param RowIndex
  83             the row index of the to-be-updated cell
  84         @param Value
  85             the new value of the cell.
  86         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  87             if the row or column index is invalid
  88     */
  89     void updateCellData( [in] long ColumnIndex, [in] long RowIndex, [in] any Value )
  90         raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
  91
  92     /** updates the content of a given row.
  93
  94         <p>The change in the data model will be notified to registered listeners via
  95         <member>XGridDataListener::dataChanged</member>. The <member>GridDataEvent::FirstColumn</member> and
  96         <member>GridDataEvent::LastColumn</member> will denote the smallest respectively largest column
  97         index from <arg>ColumnIndexes</arg>.</p>
  98
  99         @param ColumnIndexes
 100             contains the column indexes of the cells, which should be updated
 101         @param RowIndex
 102             contains the index of the row whose data is to be updated
 103         @param Values
 104             specifies the new values of the cells.
 105         @throws ::com::sun::star::lang::IndexOutOfBoundsException
 106             if one of the row indexes or the column index is invalid
 107         @throws ::com::sun::star::lang::IndexOutOfBoundsException
 108             if the lengths of the <code>ColumnIndexes</code> and <code>Values</code> sequences are not equal.
 109     */
 110     void updateRowData( [in] sequence< long > ColumnIndexes, [in] long RowIndex, [in] sequence< any > Values )
 111             raises ( ::com::sun::star::lang::IndexOutOfBoundsException
 112                    , ::com::sun::star::lang::IllegalArgumentException);
 113
 114     /** sets a new title for a given row.
 115
 116         @throws ::com::sun::star::lang::IndexOutOfBoundsException
 117             if the given index does not denote a valid row.
 118     */
 119     void
 120         updateRowHeading( [in] long RowIndex, [in] any Heading )
 121             raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
 122
 123     /** updates the tooltip to be displayed for a given cell
 124
 125         @see XGridDataModel::getCellToolTip
 126     */
 127     void updateCellToolTip( [in] long ColumnIndex, [in] long RowIndex, [in] any Value )
 128         raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
 129
 130     /** updates the tooltip for all cells of a given row
 131
 132         <p>Effectively this method is a shortcut for calling <member>updateCellToolTip</member> multiple
 133         times in a row, for all cells of a given row.</p>
 134
 135         @see XGridDataModel::getCellToolTip
 136         @see updateCellToolTip
 137     */
 138     void updateRowToolTip( [in] long RowIndex, [in] any Value )
 139         raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
 140
 141     //-------------------------------------------------------------------------
 142
 143     /** registers listener to be notified of data changes in the model
 144         @param Listener
 145             specifies the listener to register
 146     */
 147     void addGridDataListener( [in] XGridDataListener Listener );
 148
 149     //-------------------------------------------------------------------------
 150
 151     /** revokes a listener which was previously registered via <member>addGridDataListener</member>
 152         @param Listener
 153             specifies the listener to revoke.
 154     */
 155     void removeGridDataListener( [in] XGridDataListener Listener );
 156 };
 157
 158 //==================================================================================================================
 159
 160 }; }; }; }; };
 161
 162 //==================================================================================================================
 163
 164 #endif
 165
 166 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */