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
  20
  21
  22  module com {  module sun {  module star {  module drawing {
  23
  24
  25 /** gives access to a container of DrawPages or MasterPages.
  26
  27     <p>The pages are stored in an index container. The order is determined by
  28     the index.
  29
  30     You usually get this interface if you use the
  31     XDrawPagesSupplier or the XMasterPagesSupplier
  32     at a model that contains DrawPages or MasterPages
  33 */
  34 published interface XDrawPages: com::sun::star::container::XIndexAccess
  35 {
  36
  37     /** creates and inserts a new DrawPage or MasterPage
  38         into this container
  39
  40         @param nIndex
  41             the index at which the newly created DrawPage or
  42             MasterPage will be inserted.
  43
  44         @return
  45             the newly created and already inserted DrawPage or
  46             MasterPage.
  47     */
  48     com::sun::star::drawing::XDrawPage insertNewByIndex( [in] long nIndex );
  49
  50
  51     /** removes a DrawPage or MasterPage from this
  52         container.
  53
  54         @param xPage
  55             this DrawPage or MasterPage must be
  56             contained and will be removed from this container. It will
  57             also be disposed and shouldn't be used any further.
  58     */
  59     void remove( [in] com::sun::star::drawing::XDrawPage xPage );
  60
  61 };
  62
  63
  64 }; }; }; };
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */