<html> <head> <title>Interface XGalleryTheme</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XGalleryTheme-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">gallery</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XGalleryTheme</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XGalleryTheme</strong> ┗ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a> ┗ ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XElementAccess.html">XElementAccess</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>provides access to the elements of a collection through an index. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides access to the items of a Gallery themes. It also allows inserting and removing of single items. </dd> <dd><p>This interface extends the interface ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a> which provides access to existing Gallery items collection.</p> </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexAccess.html">XIndexAccess</a>, ::com::sun::star::<a href="../sheet/module-ix.html">sheet</a>::<a href="../sheet/DataPilotTable.html">DataPilotTable</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getName">getName</a></td> <td class="imsum_right">retrieves the name of the Gallery theme </td> </tr> <tr> <td class="imsum_left"><a href="#update">update</a></td> <td class="imsum_right">updates the theme </td> </tr> <tr> <td class="imsum_left"><a href="#insertURLByIndex">insertURLByIndex</a></td> <td class="imsum_right">inserts an item </td> </tr> <tr> <td class="imsum_left"><a href="#insertGraphicByIndex">insertGraphicByIndex</a></td> <td class="imsum_right">inserts an item </td> </tr> <tr> <td class="imsum_left"><a href="#insertDrawingByIndex">insertDrawingByIndex</a></td> <td class="imsum_right">inserts an item </td> </tr> <tr> <td class="imsum_left"><a href="#removeByIndex">removeByIndex</a></td> <td class="imsum_right">deletes an item from the collection </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getName" class="membertitle">getName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getName</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the name of the Gallery theme </dd> <dt><b>Returns</b></dt> <dd>The name of the Gallery theme </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="update" class="membertitle">update</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>update</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>updates the theme </dd> <dd><p>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.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="insertURLByIndex" class="membertitle">insertURLByIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>insertURLByIndex</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> URL,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> Index )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>inserts an item </dd> <dt><b>Parameter URL</b></dt> <dd>The URL of a graphic or media object, that should be added to the collection </dd> <dt><b>Parameter Index</b></dt> <dd>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. </dd> <dt><b>Returns</b></dt> <dd>The zero based position at which the object was inserted. If the object could not be inserted, -1 is returned. </dd> <dt><b>See also</b></dt> <dd><a href="XGalleryItem.html">XGalleryItem</a>, ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="insertGraphicByIndex" class="membertitle">insertGraphicByIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>insertGraphicByIndex</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a></td> <td valign="bottom"> Graphic,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> Index )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>inserts an item </dd> <dt><b>Parameter Graphic</b></dt> <dd>The ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a> object that should be added to the collection </dd> <dt><b>Parameter Index</b></dt> <dd>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. </dd> <dt><b>Returns</b></dt> <dd>The zero based position at which the object was inserted. If the object could not be inserted, -1 is returned. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a>, <a href="XGalleryItem.html">XGalleryItem</a>, ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="insertDrawingByIndex" class="membertitle">insertDrawingByIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>insertDrawingByIndex</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></td> <td valign="bottom"> Drawing,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> Index )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>inserts an item </dd> <dt><b>Parameter Drawing</b></dt> <dd>A drawing model that should be added to the collection </dd> <dt><b>Parameter Index</b></dt> <dd>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. </dd> <dt><b>Returns</b></dt> <dd>The zero based position at which the object was inserted. If the object could not be inserted, -1 is returned. </dd> <dt><b>See also</b></dt> <dd><a href="XGalleryItem.html">XGalleryItem</a>, ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeByIndex" class="membertitle">removeByIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeByIndex</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> Index )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>deletes an item from the collection </dd> <dt><b>Parameter Index</b></dt> <dd>The position of the item to be removed. The position is zero based. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
3606
