offapi/com/sun/star/drawing/XDrawPages.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: XDrawPages.idl,v $
  10  * $Revision: 1.9 $
  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_drawing_XDrawPages_idl__
  31 #define __com_sun_star_drawing_XDrawPages_idl__
  32
  33 #ifndef __com_sun_star_container_XIndexAccess_idl__
  34 #include <com/sun/star/container/XIndexAccess.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_drawing_XDrawPage_idl__
  38 #include <com/sun/star/drawing/XDrawPage.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module drawing {
  45
  46 //=============================================================================
  47
  48 /** gives access to a container of <type>DrawPage</type>s or <type>MasterPage</type>s.
  49
  50     <p>The pages are stored in an index container. The order is determined by
  51     the index.
  52
  53     You usualy get this interface if you use the
  54     <type>XDrawPagesSupplier</type> or the <type>XMasterPagesSupplier</type>
  55     at a model that contains <type>DrawPage</type>s or <type>MasterPage</type>s
  56 */
  57 published interface XDrawPages: com::sun::star::container::XIndexAccess
  58 {
  59     //-------------------------------------------------------------------------
  60
  61     /** creates and inserts a new <type>DrawPage</type> or <type>MasterPage</type>
  62         into this container
  63
  64         @param nIndex
  65             the index at which the newly created <type>DrawPage</type> or
  66             <type>MasterPage</type> will be inserted.
  67
  68         @return
  69             the newly created and already inserted <type>DrawPage</type> or
  70             <type>MasterPage</type>.
  71     */
  72     com::sun::star::drawing::XDrawPage insertNewByIndex( [in] long nIndex );
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** removes a <type>DrawPage</type> or <type>MasterPage</type> from this
  77         container.
  78
  79         @param xPage
  80             this <type>DrawPage</type> or <type>MasterPage</type> must be
  81             contained and will be removed from this container. It will
  82             also be disposed and shouldn't be used any further.
  83     */
  84     void remove( [in] com::sun::star::drawing::XDrawPage xPage );
  85
  86 };
  87
  88 //=============================================================================
  89
  90 }; }; }; };
  91
  92 #endif
  93