xref: /trunk/main/offapi/com/sun/star/sheet/DataPilotItem.idl (revision fbef625e)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_sheet_DataPilotItem_idl__
#define __com_sun_star_sheet_DataPilotItem_idl__

#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

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

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

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

/** represents a single item in a data pilot field.
 */
service DataPilotItem
{
	//-------------------------------------------------------------------------

	/** provides access to the name of the data pilot item.

	    <p>Only the <code>getName()</code> method is provided.</p>
	 */
	interface com::sun::star::container::XNamed;

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

//! service PropertySet
	/** provides access to the properties.
	 */
	interface com::sun::star::beans::XPropertySet;

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

	/** specifies whether the item is showing detail.
	 */
	[property] boolean ShowDetail;

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

    /** specifies whether the item is hidden.
    */
    [property] boolean IsHidden;

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

    /** specifies the item's position in its field if sorting is manual.

        @since OpenOffice 2.4
     */
    [optional, property] long Position;
};

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

}; }; }; };

#endif