<html> <head> <title>Interface XImageManager</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="XImageManager-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">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></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">ui</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 XImageManager</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XImageManager</strong> ┣ <a href="XUIConfigurationPersistence.html">XUIConfigurationPersistence</a> ┣ <a href="XUIConfiguration.html">XUIConfiguration</a> ┣ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a> ┗ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XInitialization.html">XInitialization</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XUIConfigurationPersistence.html">XUIConfigurationPersistence</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>provides access to persistence functions to load/store images data from a storage. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XUIConfiguration.html">XUIConfiguration</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>provides functions to add and remove listeners for changes within an image manager. </dd> <dd><p> An image manager implementation notifies its listener whenever an image set has been changed, due to insert, remove or replace operations. To minimize the overhead for notifications an image manager places all inserted and/or replaced images into a single notify call. A container which implements ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XNameAccess.html">XNameAccess</a> holds the information. The access key is a command URL and provides a ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a>. This container is placed into the <a href="ConfigurationEvent.html">ConfigurationEvent</a>::<a href="ConfigurationEvent.html#Element">Element</a>. The image set which has been changed is put into the <a href="ConfigurationEvent.html">ConfigurationEvent</a>::<a href="ConfigurationEvent.html#aInfo">aInfo</a>. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows controlling or observing the lifetime of an image manager instance. </dd> <dd><p>The owner of the object may dispose of this object using ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a>::<a href="../lang/XComponent.html#dispose">dispose()</a>. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XInitialization.html">XInitialization</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>initializes an image manager instance. An image manager instance must be initialized using ::XInitialization::initialize before it can be used.<br> The following property must be provided if the image manager is related to a module: </dd> <dd><ul> <li><b>ModuleIdentifier</b>specifies a string property which is the unique identifier of module. </li> <li><b>UserConfigStorage</b>specifies a ::com::sun::star::<a href="../embed/module-ix.html">embed</a>::<a href="../embed/XStorage.html">XStorage</a> property which provides access to the configuration storage of the module. </li> <li><b>UserRootCommit</b>specifies an optional ::com::sun::star::<a href="../embed/module-ix.html">embed</a>::<a href="../embed/XTransactedObject.html">XTransactedObject</a> property which makes it possible to commit a root storage. </li> </ul> </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>specifies access functions to an images manager interface to add, replace and remove images associations to command URLs. </dd> <dd><p> An image manager controls a number of image sets which are specified by a <a href="ImageType.html">ImageType</a>. </p> </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="#reset">reset</a></td> <td class="imsum_right">resets the image manager to default data. </td> </tr> <tr> <td class="imsum_left"><a href="#getAllImageNames">getAllImageNames</a></td> <td class="imsum_right">retrieves the list of command URLs which have images associated. </td> </tr> <tr> <td class="imsum_left"><a href="#hasImage">hasImage</a></td> <td class="imsum_right">determines if a command URL has an associated image. </td> </tr> <tr> <td class="imsum_left"><a href="#getImages">getImages</a></td> <td class="imsum_right">retrieves the associated images of command URLs. </td> </tr> <tr> <td class="imsum_left"><a href="#replaceImages">replaceImages</a></td> <td class="imsum_right">replaces the associated images of command URLs. </td> </tr> <tr> <td class="imsum_left"><a href="#removeImages">removeImages</a></td> <td class="imsum_right">removes associated images to a command URL. </td> </tr> <tr> <td class="imsum_left"><a href="#insertImages">insertImages</a></td> <td class="imsum_right">inserts new image/command associations to a image manager. </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="reset" class="membertitle">reset</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>reset</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>resets the image manager to default data. </dd> <dd><p> This means that all user images of the instance will be removed. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAllImageNames" class="membertitle">getAllImageNames</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">sequence< string ></td> </tr> <tr> <td valign="top"><b>getAllImageNames</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nImageType );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the list of command URLs which have images associated. </dd> <dt><b>Parameter nImageType</b></dt> <dd>specifies the image type for this operation. </dd> <dt><b>Returns</b></dt> <dd>all command URLs within the images manager that have an image associated. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasImage" class="membertitle">hasImage</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">boolean</td> </tr> <tr> <td valign="top"><b>hasImage</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nImageType,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aCommandURL )</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/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines if a command URL has an associated image. </dd> <dt><b>Parameter nImageType</b></dt> <dd>specifies the image type for this operation. </dd> <dt><b>Parameter ResourceURL</b></dt> <dd>a command URL that should be checked for an associated image. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if an image is associated, otherwise <b>false</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getImages" class="membertitle">getImages</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">sequence< ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a> ></td> </tr> <tr> <td valign="top"><b>getImages</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nImageType,</td> </tr> <tr> <td/><td valign="top">[in] sequence< string ></td> <td valign="bottom"> aCommandURLSequence )</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/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the associated images of command URLs. </dd> <dt><b>Parameter nImageType</b></dt> <dd>specifies the image type for this association operation. </dd> <dt><b>Parameter aCommandURLSequence</b></dt> <dd>a sequence of command URLs for which the images are requested. </dd> <dt><b>Returns</b></dt> <dd>a sequence of graphics object which are associated with the provided command URLs. If an unknown command URL is provided or a command URL has no associated image a graphics object with an empty image is provided. If the sequence <var>aCommandURLSequence</var> contains an invalid command URL a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> is thrown. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="replaceImages" class="membertitle">replaceImages</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>replaceImages</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nImageType,</td> </tr> <tr> <td/><td valign="top">[in] sequence< string ></td> <td valign="bottom"> aCommandURLSequence,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a> ></td> <td valign="bottom"> aGraphicsSequence )</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/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalAccessException.html">IllegalAccessException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>replaces the associated images of command URLs. </dd> <dt><b>Parameter nImageType</b></dt> <dd>specifies the image type for this association operation. </dd> <dt><b>Parameter aCommandURLSequence</b></dt> <dd>a sequence of command URLs for which images should be replaced. </dd> <dt><b>Parameter aGraphicsSequence</b></dt> <dd>a sequence of graphic objects which should replace the old images of the provided command URLs. <p> If a command URL cannot be found the replace call will be omitted. If <var>aCommandURLSequence</var> contains an invalid command URL a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> is thrown. If the image manager is associated with a read-only configuration manager a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalAccessException.html">IllegalAccessException</a> is thrown. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeImages" class="membertitle">removeImages</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>removeImages</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nImageType,</td> </tr> <tr> <td/><td valign="top">[in] sequence< string ></td> <td valign="bottom"> aResourceURLSequence )</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/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalAccessException.html">IllegalAccessException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes associated images to a command URL. </dd> <dt><b>Parameter nImageType</b></dt> <dd>specifies the image type for this association operation. </dd> <dt><b>Parameter aCommandURLSequence</b></dt> <dd>a sequence of command URLs for which the images should be removed. <p> If the <var>aCommandURLSequence</var> contains an invalid command URL a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> is thrown. If the image manager is associated with a read-only configuration manager a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalAccessException.html">IllegalAccessException</a> is thrown. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="insertImages" class="membertitle">insertImages</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>insertImages</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nImageType,</td> </tr> <tr> <td/><td valign="top">[in] sequence< string ></td> <td valign="bottom"> aCommandURLSequence,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a> ></td> <td valign="bottom"> aGraphicSequence )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/ElementExistException.html">ElementExistException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalAccessException.html">IllegalAccessException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>inserts new image/command associations to a image manager. </dd> <dt><b>Parameter nImageType</b></dt> <dd>specifies the image type for this association operation. </dd> <dt><b>Parameter aCommandURLSequence</b></dt> <dd>a sequence of command URLs which specify which commands get an new image. </dd> <dt><b>Parameter aGraphicSequence</b></dt> <dd>a sequence of graphic objects which should be associated with the provided command URLs. <p> If an association is already present it is replaced. If <var>aCommandURLSequence</var> contains an invalid command URL a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> is thrown. If the configuration manager is read-only a ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalAccessException.html">IllegalAccessException</a> is thrown. </p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "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 <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
