offapi/com/sun/star/drawing/XDrawPages.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_drawing_XDrawPages_idl__
  20 #define __com_sun_star_drawing_XDrawPages_idl__
  21
  22 #include <com/sun/star/container/XIndexAccess.idl>
  23
  24 #include <com/sun/star/drawing/XDrawPage.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module drawing {
  29
  30
  31 /** gives access to a container of DrawPages or MasterPages.
  32
  33     <p>The pages are stored in an index container. The order is determined by
  34     the index.
  35
  36     You usually get this interface if you use the
  37     XDrawPagesSupplier or the XMasterPagesSupplier
  38     at a model that contains DrawPages or MasterPages
  39 */
  40 published interface XDrawPages: com::sun::star::container::XIndexAccess
  41 {
  42
  43     /** creates and inserts a new DrawPage or MasterPage
  44         into this container
  45
  46         @param nIndex
  47             the index at which the newly created DrawPage or
  48             MasterPage will be inserted.
  49
  50         @return
  51             the newly created and already inserted DrawPage or
  52             MasterPage.
  53     */
  54     com::sun::star::drawing::XDrawPage insertNewByIndex( [in] long nIndex );
  55
  56
  57     /** removes a DrawPage or MasterPage from this
  58         container.
  59
  60         @param xPage
  61             this DrawPage or MasterPage must be
  62             contained and will be removed from this container. It will
  63             also be disposed and shouldn't be used any further.
  64     */
  65     void remove( [in] com::sun::star::drawing::XDrawPage xPage );
  66
  67 };
  68
  69
  70 }; }; }; };
  71
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */