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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XListBox.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_grid_XGridDataModel_idl__
  31 #define __com_sun_star_awt_grid_XGridDataModel_idl__
  32
  33
  34 #include <com/sun/star/lang/XComponent.idl>
  35 #include <com/sun/star/awt/grid/XGridDataListener.idl>
  36
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module awt { module grid {
  41
  42 //=============================================================================
  43 /** An instance of this interface is used by the <type>UnoControlGrid</type> to
  44     retrieve the content data that is displayed in the actual control.
  45
  46     If you do not need your own model implementation, you can also use the <type>DefaultGridDataModel</type>.
  47 */
  48 interface XGridDataModel: ::com::sun::star::lang::XComponent
  49 {
  50     /** Specifies the height of each row.
  51     */
  52     [attribute] long RowHeight;
  53
  54     /** Contains the row header.
  55     */
  56     [attribute] sequence< string > RowHeaders;
  57
  58     /** Returns the content of each row.
  59     */
  60     [attribute,readonly] sequence< sequence< string > > Data;
  61
  62     /** Returns the number of rows in in the model.
  63         @returns
  64                 the number of rows.
  65     */
  66     long getRowCount();
  67
  68     /** Adds a row to the model.
  69
  70         @param headername
  71                 specifies the name of the row.
  72         @param data
  73                 the content of the row.
  74     */
  75     void addRow( [in] string headername, [in] sequence< string > data );
  76
  77     /** Removes a row from the model.
  78
  79         @param index
  80                 the index of the row that should be removed.
  81     */
  82     void removeRow( [in] long index);
  83
  84     /** Removes all rows from the model.
  85     */
  86     void removeAll();
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** Adds a listener for the <type>GridDataEvent</type> posted after the grid changes.
  91         @param Listener
  92             the listener to add.
  93     */
  94     [oneway] void addDataListener( [in] XGridDataListener  listener);
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** Removes a listener previously added with <method>addDataListener()</method>.
  99         @param Listener
 100             the listener to remove.
 101     */
 102     [oneway] void removeDataListener( [in] XGridDataListener listener);
 103
 104 };
 105
 106 //=============================================================================
 107
 108 }; }; }; };};
 109
 110 #endif