xref: /aoo42x/main/offapi/com/sun/star/drawing/XDrawPages.idl (revision a893be29)

/**************************************************************
 *
 * 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_drawing_XDrawPages_idl__
#define __com_sun_star_drawing_XDrawPages_idl__

#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif

#ifndef __com_sun_star_drawing_XDrawPage_idl__
#include <com/sun/star/drawing/XDrawPage.idl>
#endif


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

 module com {  module sun {  module star {  module drawing {

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

/** gives access to a container of <type>DrawPage</type>s or <type>MasterPage</type>s.

	<p>The pages are stored in an index container. The order is determined by
	the index.

	You usually get this interface if you use the
	<type>XDrawPagesSupplier</type> or the <type>XMasterPagesSupplier</type>
	at a model that contains <type>DrawPage</type>s or <type>MasterPage</type>s
*/
published interface XDrawPages: com::sun::star::container::XIndexAccess
{
	//-------------------------------------------------------------------------

	/** creates and inserts a new <type>DrawPage</type> or <type>MasterPage</type>
		into this container

		@param nIndex
			the index at which the newly created <type>DrawPage</type> or
			<type>MasterPage</type> will be inserted.

		@return
			the newly created and already inserted <type>DrawPage</type> or
			<type>MasterPage</type>.
	*/
	com::sun::star::drawing::XDrawPage insertNewByIndex( [in] long nIndex );

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

	/** removes a <type>DrawPage</type> or <type>MasterPage</type> from this
		container.

		@param xPage
			this <type>DrawPage</type> or <type>MasterPage</type> must be
			contained and will be removed from this container. It will
			also be disposed and shouldn't be used any further.
	*/
	void remove( [in] com::sun::star::drawing::XDrawPage xPage );

};

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

}; }; }; };

#endif