offapi/com/sun/star/sheet/DataPilotSourceMember.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_DataPilotSourceMember_idl__
  29 #define __com_sun_star_sheet_DataPilotSourceMember_idl__
  30
  31 #ifndef __com_sun_star_container_XNamed_idl__
  32 #include <com/sun/star/container/XNamed.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_beans_XPropertySet_idl__
  36 #include <com/sun/star/beans/XPropertySet.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module sheet {
  42
  43 //=============================================================================
  44
  45 /** represents a member in a data pilot source level.
  46
  47     <p>Members are the data items that will appear in a data pilot table
  48     as row headers and column headers of the data range (if used in
  49     row or column dimensions), or to calculate the values of the
  50     data range (if used in data dimensions).</p>
  51
  52     @see com::sun::star::sheet::DataPilotSourceLevel
  53     @see com::sun::star::sheet::DataPilotSource
  54  */
  55 published service DataPilotSourceMember
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     /** provides access to the name of the member.
  60
  61         <p>This may be the textual representation of a numerical value.</p>
  62      */
  63     interface com::sun::star::container::XNamed;
  64
  65     //-------------------------------------------------------------------------
  66
  67 //!published service PropertySet
  68     /** provides access to the properties.
  69      */
  70     interface com::sun::star::beans::XPropertySet;
  71
  72     //=========================================================================
  73
  74     /** specifies whether the member is visible.
  75      */
  76     [property] boolean IsVisible;
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** specifies whether details for the member are shown.
  81      */
  82     [property] boolean ShowDetails;
  83
  84     //-------------------------------------------------------------------------
  85
  86     /** specifies the member's position in its hierarchy level if sorting
  87         is manual.
  88
  89         @since OOo 2.4.0
  90      */
  91     [optional, property] boolean Position;
  92 };
  93
  94 //=============================================================================
  95
  96 }; }; }; };
  97
  98 #endif
  99