Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: gallery ::
unpublished | interface XGalleryTheme |
  Base Interfaces
      XGalleryTheme
      ┗ ::com::sun::star::container::XIndexAccess
         ┗ ::com::sun::star::container::XElementAccess
  ::com::sun::star::container::XIndexAccess | (referenced interface's summary:) provides access to the elements of a collection through an index.
Usage Restrictions not published Description provides access to the items of a Gallery themes. It also allows inserting and removing of single items. This interface extends the interface ::com::sun::star::container::XIndexAccess which provides access to existing Gallery items collection. See also ::com::sun::star::container::XIndexAccess, ::com::sun::star::sheet::DataPilotTable

Methods' Summary
getName | retrieves the name of the Gallery theme
update | updates the theme
insertURLByIndex | inserts an item
insertGraphicByIndex | inserts an item
insertDrawingByIndex | inserts an item
removeByIndex | deletes an item from the collection

Methods' Details
getName
string
getName();
Description retrieves the name of the Gallery theme Returns The name of the Gallery theme
update
void
update();
Description updates the theme This method iterates over each item of the Gallery theme and updates it accordingly. Main purpose is to automatically regenerate the thumbnails and to remove invalid items, that is items who have got an URL that has become invalid. This method also optimizes underlying data structures.
insertURLByIndex
long
insertURLByIndex( | [in] string | URL,
| [in] long | Index )
raises( | ::com::sun::star::lang::WrappedTargetException );
Description inserts an item Parameter URL The URL of a graphic or media object, that should be added to the collection Parameter Index The zero based index of the position where to insert the new object inside the collection. If the index is larger than or equal to the number of already inserted items, the item is inserted at the end of the collection. If the index is smaller than 0, the item is inserted at the beginning of the collection. Returns The zero based position at which the object was inserted. If the object could not be inserted, -1 is returned. See also XGalleryItem, ::com::sun::star::lang::WrappedTargetException
insertGraphicByIndex
long
insertGraphicByIndex( | [in] ::com::sun::star::graphic::XGraphic | Graphic,
| [in] long | Index )
raises( | ::com::sun::star::lang::WrappedTargetException );
Description inserts an item Parameter Graphic The ::com::sun::star::graphic::XGraphic object that should be added to the collection Parameter Index The zero based index of the position where to insert the new object inside the collection. If the index is larger than or equal to the number of already inserted items, the item is inserted at the end of the collection. If the index is smaller than 0, the item is inserted at the beginning of the collection. Returns The zero based position at which the object was inserted. If the object could not be inserted, -1 is returned. See also ::com::sun::star::graphic::XGraphic, XGalleryItem, ::com::sun::star::lang::WrappedTargetException
insertDrawingByIndex
long
insertDrawingByIndex( | [in] ::com::sun::star::lang::XComponent | Drawing,
| [in] long | Index )
raises( | ::com::sun::star::lang::WrappedTargetException );
Description inserts an item Parameter Drawing A drawing model that should be added to the collection Parameter Index The zero based index of the position where to insert the new object inside the collection. If the index is larger than or equal to the number of already inserted items, the item is inserted at the end of the collection. If the index is smaller than 0, the item is inserted at the beginning of the collection. Returns The zero based position at which the object was inserted. If the object could not be inserted, -1 is returned. See also XGalleryItem, ::com::sun::star::lang::WrappedTargetException
removeByIndex
void
removeByIndex( | [in] long | Index )
raises( | ::com::sun::star::lang::IndexOutOfBoundsException );
Description deletes an item from the collection Parameter Index The position of the item to be removed. The position is zero based. See also ::com::sun::star::container::NoSuchElementException

Top of Page

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.