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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_UnoControlGrid_idl__
  29 #define __com_sun_star_awt_UnoControlGrid_idl__
  30
  31 #include <com/sun/star/awt/UnoControl.idl>
  32
  33 #include <com/sun/star/awt/grid/XGridControl.idl>
  34
  35 //=============================================================================
  36
  37  module com {  module sun {  module star {  module awt {  module grid {
  38
  39 //=============================================================================
  40
  41 //=============================================================================
  42
  43 /** A control that displays a set of tabular data.
  44
  45     <p>
  46     <h4>The Column Model</h4>
  47     <p>The horizontal structure of the grid is defined by the <type>XGridColumnModel</type> implemented in <type>DefaultGridColumnModel</type>
  48     The <type>XGridColumn</type> implemented in <type>GridColumn</type> describes the properties and behavior of a single column. Use the <member>XGridColumnModel::addColumn()</member> to add a column to the column model.
  49     </p>
  50     <p>
  51     <h4>The Data Model</h4>
  52     <p> All row data are stored in the <type>XGridDataModel</type>.
  53     Use the <type>DefaultGridDataModel</type> to add  <member>XGridDataModel::addRow()</member> or remove <member>XGridDataModel::removeRow()</member> rows.
  54     </p>
  55
  56     <p>The column and data model must be set at the <member>UnoControlGridModel::ColumnModel</member> and <member>UnoControlGridModel::GridDataModel</member> properties.</p>
  57
  58     <h4>Selection</h4>
  59     <p>If you are interested in knowing when the selection changes implement a
  60     <type>XGridSelectionListener</type> and add the instance with the method
  61     <member>XGridSelection::addSelectionListener()</member>.
  62     You than will be notified for any selection change.
  63
  64     The <type>XGridSelection</type> interface provides a bunch of methods to set and get selection for the grid control.
  65     </p>
  66     @since OOo 3.3
  67  */
  68 service UnoControlGrid
  69 {
  70     service com::sun::star::awt::UnoControl;
  71
  72     interface com::sun::star::awt::grid::XGridControl;
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };};
  78
  79 #endif
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */