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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21  module com {  module sun {  module star {  module awt {  module grid {
  22
  23
  24
  25 /** A control that displays a set of tabular data.
  26
  27     <h4>The Column Model</h4>
  28
  29     <p>The horizontal structure of the grid is defined by the XGridColumnModel implemented in DefaultGridColumnModel
  30     The XGridColumn implemented in GridColumn describes the properties and behavior of a single column. Use the XGridColumnModel::addColumn() to add a column to the column model.
  31     </p>
  32
  33     <h4>The Data Model</h4>
  34     <p> All row data are stored in the XGridDataModel.
  35     Use the DefaultGridDataModel to add  XGridDataModel::addRow() or remove XGridDataModel::removeRow() rows.
  36     </p>
  37
  38     <p>The column and data model must be set at the UnoControlGridModel::ColumnModel and UnoControlGridModel::GridDataModel properties.</p>
  39
  40     <h4>Selection</h4>
  41     <p>If you are interested in knowing when the selection changes implement a
  42     XGridSelectionListener and add the instance with the method
  43     XGridRowSelection::addSelectionListener().
  44     You than will be notified for any selection change.</p>
  45
  46     @since OOo 3.3
  47  */
  48 service UnoControlGrid
  49 {
  50     service com::sun::star::awt::UnoControl;
  51
  52     interface ::com::sun::star::awt::grid::XGridControl;
  53
  54     interface ::com::sun::star::awt::grid::XGridRowSelection;
  55 };
  56
  57
  58 }; }; }; };};
  59
  60 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */