offapi/com/sun/star/form/XGridFieldDataSupplier.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 form {
  23
  24
  25 /** provides access to the data of a GridControl
  26
  27     <p>You can retrieve the data type information and the data in a row.</p>
  28
  29     <p>This interface allows to retrieve data even for rows which are not current, which is quite useful,
  30     as normally, you can't affect the current row in a grid control without moving the cursor of the underlying
  31     com::sun::star::form::component::DataForm.</p>
  32
  33     @see XGrid
  34     @see com::sun::star::form::control::GridControl
  35     @see com::sun::star::form::component::GridControl
  36
  37     @deprecated
  38  */
  39 published interface XGridFieldDataSupplier: com::sun::star::uno::XInterface
  40 {
  41     /** checks whether or not the content of the grid's columns can be retrieved in the requested format.
  42
  43         <p>Not every cell content can be retrieved in every representation. For example, in a text column,
  44         you usually won't be able to retrieve the content as double.<br/>
  45         To check if the type you need is supported by the columns, use this method.</p>
  46
  47         @return
  48             A sequence of boolean flags. Each flag corresponds to the respective column, and `TRUE` indicates
  49             that the column content can be retrieved in the requested format, `FALSE` denies this.
  50
  51         @see XGridColumnFactory
  52         @see DataAwareControlModel
  53         @see XGridFieldDataSupplier::queryFieldData
  54     */
  55     sequence<boolean> queryFieldDataType( [in] type xType );
  56
  57     /** retrieves the actual column data for the given row
  58
  59         <p>If a column does not support the requested type, `NULL` is returned at the respective
  60         position.</p>
  61
  62         @see XGridFieldDataSupplier::queryFieldDataType
  63     */
  64     sequence<any> queryFieldData( [in] long nRow,
  65              [in] type xType );
  66 };
  67
  68
  69 }; }; }; };
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */