offapi/com/sun/star/gallery/XGalleryTheme.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 module com {  module sun {  module star {  module gallery {
  22
  23
  24 /** provides access to the items of a Gallery themes. It also allows
  25     inserting and removing of single items.
  26
  27     <p>This interface extends the interface
  28     com::sun::star::container::XIndexAccess which provides
  29     access to existing Gallery items collection.</p>
  30
  31     @see com::sun::star::container::XIndexAccess
  32     @see com::sun::star::sheet::DataPilotTable
  33  */
  34 interface XGalleryTheme : com::sun::star::container::XIndexAccess
  35 {
  36     /** retrieves the name of the Gallery theme
  37
  38         @returns
  39             The name of the Gallery theme
  40      */
  41     string getName();
  42
  43     /** updates the theme
  44
  45         <p>This method iterates over each item of the Gallery theme
  46         and updates it accordingly. Main purpose is to automatically
  47         regenerate the thumbnails and to remove invalid items, that is items
  48         who have got a URL that has become invalid. This method also
  49         optimizes underlying data structures.</p>
  50      */
  51     void update();
  52
  53     /** inserts an item
  54
  55         @param URL
  56             The URL of a graphic or media object, that should
  57             be added to the collection
  58
  59         @param Index
  60             The zero based index of the position where to insert
  61             the new object inside the collection. If the index is larger than
  62             or equal to the number of already inserted items, the
  63             item is inserted at the end of the collection. If the index
  64             is smaller than 0, the item is inserted at the beginning of
  65             the collection.
  66
  67         @returns
  68             The zero based position at which the object was inserted.
  69             If the object could not be inserted, -1 is returned.
  70
  71         @see XGalleryItem
  72         @see com::sun::star::lang::WrappedTargetException
  73     */
  74     long insertURLByIndex( [in] string URL, [in] long Index )
  75         raises ( com::sun::star::lang::WrappedTargetException );
  76     /** inserts an item
  77
  78         @param Graphic
  79             The com::sun::star::graphic::XGraphic object
  80             that should be added to the collection
  81
  82         @param Index
  83             The zero based index of the position where to insert
  84             the new object inside the collection. If the index is larger than
  85             or equal to the number of already inserted items, the
  86             item is inserted at the end of the collection. If the index
  87             is smaller than 0, the item is inserted at the beginning of
  88             the collection.
  89
  90         @returns
  91             The zero based position at which the object was inserted.
  92             If the object could not be inserted, -1 is returned.
  93
  94         @see com::sun::star::graphic::XGraphic
  95         @see XGalleryItem
  96         @see com::sun::star::lang::WrappedTargetException
  97     */
  98     long insertGraphicByIndex( [in] com::sun::star::graphic::XGraphic Graphic, [in] long Index )
  99         raises ( com::sun::star::lang::WrappedTargetException );
 100
 101     /** inserts an item
 102
 103         @param Drawing
 104             A drawing model that should be added to the collection
 105
 106         @param Index
 107             The zero based index of the position where to insert
 108             the new object inside the collection. If the index is larger than
 109             or equal to the number of already inserted items, the
 110             item is inserted at the end of the collection. If the index
 111             is smaller than 0, the item is inserted at the beginning of
 112             the collection.
 113
 114         @returns
 115             The zero based position at which the object was inserted.
 116             If the object could not be inserted, -1 is returned.
 117
 118         @see XGalleryItem
 119         @see com::sun::star::lang::WrappedTargetException
 120     */
 121     long insertDrawingByIndex( [in] com::sun::star::lang::XComponent Drawing, [in] long Index )
 122         raises ( com::sun::star::lang::WrappedTargetException );
 123
 124     /** deletes an item from the collection
 125
 126         @param Index
 127             The position of the item to be removed. The
 128             position is zero based.
 129
 130         @see com::sun::star::container::NoSuchElementException
 131     */
 132     void removeByIndex( [in] long Index )
 133         raises ( com::sun::star::lang::IndexOutOfBoundsException );
 134 };
 135
 136
 137 }; }; }; };
 138
 139 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */