/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: TableFilterField.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 04:58:16 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_TableFilterField2_idl__
#define __com_sun_star_sheet_TableFilterField2_idl__


#ifndef __com_sun_star_sheet_FilterConnection_idl__
#include <com/sun/star/sheet/FilterConnection.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** describes a single condition in a filter descriptor.

   <p>This struct has the <type>FilterOperator2</type> constants group as
   member, whereas the <type>TableFilterField</type> struct uses the
   <type>FilterOperator</type> enum.</p>

    @see com::sun::star::sheet::SheetFilterDescriptor

    @since OOo 3.0
 */
published struct TableFilterField2
{
		//-------------------------------------------------------------------------

	/** specifies how the condition is connected to the previous condition.
	 */
	FilterConnection Connection;

	//-------------------------------------------------------------------------

	/** specifies which field (column) is used for the condition.
	 */
	long Field;

	//-------------------------------------------------------------------------

	/** specifies the type of the condition as defined in <type>FilterOperator2</type>.
     */
	long Operator;

	//-------------------------------------------------------------------------

	/** selects whether the <member>TableFilterField2::NumericValue</member>
		or the <member>TableFilterField2::StringValue</member> is used.
	 */
	boolean IsNumeric;

	//-------------------------------------------------------------------------

	/** specifies a numeric value for the condition.
	 */
	double NumericValue;

	//-------------------------------------------------------------------------

	/** specifies a string value for the condition.
	 */
	string StringValue;

};

//=============================================================================

}; }; }; };


#endif