offapi/com/sun/star/sheet/DataPilotFieldAutoShowInfo.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: DataPilotFieldAutoShowInfo.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
  31 #ifndef __com_sun_star_sheet_DataPilotFieldAutoShowInfo_idl__
  32 #define __com_sun_star_sheet_DataPilotFieldAutoShowInfo_idl__
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module sheet {
  37
  38 //=============================================================================
  39
  40 /** contains the auto show information of a DataPilotField.
  41
  42     <p>If enabled, only a number of items with the highest or lowest result
  43     values are shown. The other items are hidden automatically.</p>
  44
  45     @see com::sun::star::sheet::DataPilotField
  46  */
  47 published struct DataPilotFieldAutoShowInfo
  48 {
  49     //-------------------------------------------------------------------------
  50
  51     /** specifies whether the AutoShow feature is enabled or not.
  52         */
  53
  54         boolean IsEnabled;
  55
  56     //-------------------------------------------------------------------------
  57
  58     /** specifies the mode which items have to be shown.
  59
  60     @see com::sun::star::sheet::DataPilotFieldShowItemsMode
  61
  62         */
  63
  64         long ShowItemsMode;
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** specifies the number of the items to show.
  69         */
  70
  71         long ItemCount;
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** specifies the field where the values to show and select are taken from.
  76         */
  77
  78         string DataField;
  79 };
  80
  81 //=============================================================================
  82
  83 }; }; }; };
  84
  85 #endif
  86