offapi/com/sun/star/sheet/DataPilotFieldSortInfo.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: DataPilotFieldSortInfo.idl,v $
  10  * $Revision: 1.5 $
  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_sheet_DataPilotFieldSortInfo_idl__
  31 #define __com_sun_star_sheet_DataPilotFieldSortInfo_idl__
  32
  33 #ifndef __com_sun_star_sheet_DataPilotFieldSortMode_idl__
  34 #include <com/sun/star/sheet/DataPilotFieldSortMode.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com {  module sun {  module star {  module sheet {
  40
  41 //=============================================================================
  42 /** describes how to sort a single DataPilotField
  43  */
  44 published struct DataPilotFieldSortInfo
  45 {
  46     //-------------------------------------------------------------------------
  47
  48     /** contains the data field to sort by if the Mode is DATA
  49      */
  50
  51     string Field;
  52
  53     //-------------------------------------------------------------------------
  54
  55     /** <TRUE/> if data are sorted in ascending order,
  56         <FALSE/> if in descending order.
  57      */
  58
  59     boolean IsAscending;
  60
  61     //-------------------------------------------------------------------------
  62
  63     /** contains the sort mode
  64
  65     @see com::sun::star::sheet::DataPilotFieldSortMode
  66
  67      */
  68
  69     long Mode;
  70
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 #endif