131 lines
5.1 KiB
Text
131 lines
5.1 KiB
Text
/*************************************************************************
|
|
*
|
|
* $RCSfile: XGridFieldDataSupplier.idl,v $
|
|
*
|
|
* $Revision: 1.8 $
|
|
*
|
|
* last change: $Author: obo $ $Date: 2004-06-03 19:42:45 $
|
|
*
|
|
* The Contents of this file are made available subject to the terms of
|
|
* either of the following licenses
|
|
*
|
|
* - GNU Lesser General Public License Version 2.1
|
|
* - Sun Industry Standards Source License Version 1.1
|
|
*
|
|
* Sun Microsystems Inc., October, 2000
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2000 by Sun Microsystems, Inc.
|
|
* 901 San Antonio Road, Palo Alto, CA 94303, USA
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License version 2.1, as published by the Free Software Foundation.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
* MA 02111-1307 USA
|
|
*
|
|
*
|
|
* Sun Industry Standards Source License Version 1.1
|
|
* =================================================
|
|
* The contents of this file are subject to the Sun Industry Standards
|
|
* Source License Version 1.1 (the "License"); You may not use this file
|
|
* except in compliance with the License. You may obtain a copy of the
|
|
* License at http://www.openoffice.org/license.html.
|
|
*
|
|
* Software provided under this License is provided on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
|
|
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
|
|
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
|
|
* See the License for the specific provisions governing your rights and
|
|
* obligations concerning the Software.
|
|
*
|
|
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
|
|
*
|
|
* Copyright: 2000 by Sun Microsystems, Inc.
|
|
*
|
|
* All Rights Reserved.
|
|
*
|
|
* Contributor(s): _______________________________________
|
|
*
|
|
*
|
|
************************************************************************/
|
|
#ifndef __com_sun_star_form_XGridFieldDataSupplier_idl__
|
|
#define __com_sun_star_form_XGridFieldDataSupplier_idl__
|
|
|
|
#ifndef __com_sun_star_uno_XInterface_idl__
|
|
#include <com/sun/star/uno/XInterface.idl>
|
|
#endif
|
|
|
|
#ifndef __com_sun_star_reflection_XIdlClass_idl__
|
|
#include <com/sun/star/reflection/XIdlClass.idl>
|
|
#endif
|
|
|
|
|
|
//=============================================================================
|
|
|
|
module com { module sun { module star { module form {
|
|
|
|
//=============================================================================
|
|
|
|
/** provides access to the data of a GridControl
|
|
|
|
<p>You can retrieve the data type information and the data in a row.</p>
|
|
|
|
<p>This interface allows to retrieve data even for rows which are not current, which is quite usefull,
|
|
as normally, you can't affect the current row in a grid control without moving the cursor of the underlying
|
|
<type scope="com::sun::star::form::component">DataForm</type>.</p>
|
|
|
|
@see XGrid
|
|
@see com::sun::star::form::control::GridControl
|
|
@see com::sun::star::form::component::GridControl
|
|
|
|
@deprecated
|
|
*/
|
|
published interface XGridFieldDataSupplier: com::sun::star::uno::XInterface
|
|
{
|
|
//-------------------------------------------------------------------------
|
|
/** checks whether or not the content of the grid's columns can be retrieved in the requested format.
|
|
|
|
<p>Not every cell content can be retrieved in every representation. For example, in a text column,
|
|
you usually won't be able to retrieve the content as double.<br/>
|
|
To check if the type you need is supported by the columns, use this method.</p>
|
|
|
|
@return
|
|
A sequence of boolean flags. Each flag corresponds to the respective column, and <TRUE/> indicates
|
|
that the column content can be retrieved in the requested format, <FALSE/> denies this.
|
|
|
|
@see XGridColumnFactory
|
|
@see DataAwareControlModel
|
|
@see XGridFieldDataSupplier::queryFieldData
|
|
*/
|
|
sequence<boolean> queryFieldDataType( [in] type xType );
|
|
|
|
//-------------------------------------------------------------------------
|
|
/** retrieves the actual column data for the given row
|
|
|
|
<p>If a column does not support the requested type, <NULL/> is returned at the respective
|
|
position.</p>
|
|
|
|
@see XGridFieldDataSupplier::queryFieldDataType
|
|
*/
|
|
sequence<any> queryFieldData( [in] long nRow,
|
|
[in] type xType );
|
|
};
|
|
|
|
//=============================================================================
|
|
|
|
}; }; }; };
|
|
|
|
/*=============================================================================
|
|
|
|
=============================================================================*/
|
|
#endif
|