offapi/com/sun/star/awt/grid/XGridDataModel.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
  22 module com {  module sun {  module star {  module awt { module grid {
  23
  24 /** An instance of this interface is used by the UnoControlGrid to
  25     retrieve the content data that is displayed in the actual control.
  26
  27     If you do not need your own model implementation, you can also use the DefaultGridDataModel.
  28
  29     @since OOo 3.3
  30 */
  31 published interface XGridDataModel
  32 {
  33     /** implements life time control for the component
  34     */
  35     interface ::com::sun::star::lang::XComponent;
  36
  37     /** allows cloning the complete data model
  38     */
  39     interface ::com::sun::star::util::XCloneable;
  40
  41     /** denotes the number of rows for which the model can provide data
  42     */
  43     [attribute, readonly] long RowCount;
  44
  45     /** denotes the number of columns for which the model can provide data
  46     */
  47     [attribute, readonly] long ColumnCount;
  48
  49     /** retrieves the data for a given cell
  50
  51         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  52             if the column or row index do not denote a valid cell position.
  53     */
  54     any getCellData( [in] long Column, [in] long RowIndex )
  55         raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
  56
  57     /** retrieves the tool tip to be displayed when the mouse hovers over a given cell
  58
  59         <p>At the moment, only string tool tips are supported.</p>
  60
  61         <p>If `VOID` is returned here, the cell's content will be displayed as tip, but only if it does
  62         not fit into the cell.</p>
  63
  64         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  65             if the column or row index do not denote a valid cell position.
  66     */
  67     any getCellToolTip( [in] long Column, [in] long RowIndex )
  68         raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
  69
  70     /** retrieves the heading of a given row
  71
  72         <p>A grid control will usually paint a row's title in the header column of the respective row.</p>
  73
  74         <p>At the moment, only strings are supported as row headings.</p>
  75
  76         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  77             if the given index does not denote a valid row.
  78     */
  79     any
  80         getRowHeading( [in] long RowIndex )
  81         raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
  82
  83     /** retrieves the data for a complete row
  84
  85         <p>This method is provided for performance and convenience reasons, it delivers the same result
  86         as subsequent calls to getCellData() would.</p>
  87
  88         @param RowIndex
  89             the index of the row whose data should is to be retrieved.
  90         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  91             of the given row index does not denote a valid row.
  92     */
  93     sequence< any >
  94         getRowData( [in] long RowIndex )
  95         raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
  96 };
  97
  98
  99 }; }; }; };};
 100
 101 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */