offapi/com/sun/star/form/XGridFieldDataSupplier.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: XGridFieldDataSupplier.idl,v $
  10  * $Revision: 1.10 $
  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_form_XGridFieldDataSupplier_idl__
  31 #define __com_sun_star_form_XGridFieldDataSupplier_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_reflection_XIdlClass_idl__
  38 #include <com/sun/star/reflection/XIdlClass.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module form {
  45
  46 //=============================================================================
  47
  48 /** provides access to the data of a GridControl
  49
  50     <p>You can retrieve the data type information and the data in a row.</p>
  51
  52     <p>This interface allows to retrieve data even for rows which are not current, which is quite usefull,
  53     as normally, you can't affect the current row in a grid control without moving the cursor of the underlying
  54     <type scope="com::sun::star::form::component">DataForm</type>.</p>
  55
  56     @see XGrid
  57     @see com::sun::star::form::control::GridControl
  58     @see com::sun::star::form::component::GridControl
  59
  60     @deprecated
  61  */
  62 published interface XGridFieldDataSupplier: com::sun::star::uno::XInterface
  63 {
  64     //-------------------------------------------------------------------------
  65     /** checks whether or not the content of the grid's columns can be retrieved in the requested format.
  66
  67         <p>Not every cell content can be retrieved in every representation. For example, in a text column,
  68         you usually won't be able to retrieve the content as double.<br/>
  69         To check if the type you need is supported by the columns, use this method.</p>
  70
  71         @return
  72             A sequence of boolean flags. Each flag corresponds to the respective column, and <TRUE/> indicates
  73             that the column content can be retrieved in the requested format, <FALSE/> denies this.
  74
  75         @see XGridColumnFactory
  76         @see DataAwareControlModel
  77         @see XGridFieldDataSupplier::queryFieldData
  78     */
  79     sequence<boolean> queryFieldDataType( [in] type xType );
  80
  81     //-------------------------------------------------------------------------
  82     /** retrieves the actual column data for the given row
  83
  84         <p>If a column does not support the requested type, <NULL/> is returned at the respective
  85         position.</p>
  86
  87         @see XGridFieldDataSupplier::queryFieldDataType
  88     */
  89     sequence<any> queryFieldData( [in] long nRow,
  90              [in] type xType );
  91 };
  92
  93 //=============================================================================
  94
  95 }; }; }; };
  96
  97 /*=============================================================================
  98
  99 =============================================================================*/
 100 #endif