<html> <head> <title>Interface XPopupMenuExtended</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="XPopupMenuExtended-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">awt</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 XPopupMenuExtended</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XPopupMenuExtended</strong> ┣ <a href="XPopupMenu.html">XPopupMenu</a> ┃ ┗ <a href="XMenu.html">XMenu</a> ┗ <a href="XMenuExtended2.html">XMenuExtended2</a> ┣ <a href="XMenuExtended.html">XMenuExtended</a> ┗ <a href="XMenu.html">XMenu</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XPopupMenu.html">XPopupMenu</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>specifies basic functions for a popup menu. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XMenuExtended2.html">XMenuExtended2</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>specifies extended menu functions, available for both <a href="MenuBar.html">MenuBar</a> and <a href="PopupMenu.html">PopupMenu</a>. </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 extended functions for a <a href="PopupMenu.html">PopupMenu</a>. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</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="#isInExecute">isInExecute</a></td> <td class="imsum_right">queries if the <a href="PopupMenu.html">PopupMenu</a> is being executed as a result of invoking <a href="XPopupMenu.html">XPopupMenu</a>::<a href="XPopupMenu.html#execute">execute()</a>; that is, for a <a href="PopupMenu.html">PopupMenu</a> activated by a <a href="MenuBar.html">MenuBar</a> item, this methods returns <b>false</b>. </td> </tr> <tr> <td class="imsum_left"><a href="#endExecute">endExecute</a></td> <td class="imsum_right">ends the execution of the <a href="PopupMenu.html">PopupMenu</a>. <a href="XPopupMenu.html">XPopupMenu</a>::<a href="XPopupMenu.html#execute">execute()</a> will then return 0. </td> </tr> <tr> <td class="imsum_left"><a href="#setLogo">setLogo</a></td> <td class="imsum_right">sets the <a href="MenuLogo.html">MenuLogo</a> for this <a href="PopupMenu.html">PopupMenu</a>. </td> </tr> <tr> <td class="imsum_left"><a href="#getLogo">getLogo</a></td> <td class="imsum_right">retrieves the <a href="MenuLogo.html">MenuLogo</a> for this <a href="PopupMenu.html">PopupMenu</a>. </td> </tr> <tr> <td class="imsum_left"><a href="#enableAutoMnemonics">enableAutoMnemonics</a></td> <td class="imsum_right">specifies whether mnemonics are automatically assigned to menu items, or not. </td> </tr> <tr> <td class="imsum_left"><a href="#setAcceleratorKeyEvent">setAcceleratorKeyEvent</a></td> <td class="imsum_right">sets the <a href="KeyEvent.html">KeyEvent</a> for the menu item. </td> </tr> <tr> <td class="imsum_left"><a href="#getAcceleratorKeyEvent">getAcceleratorKeyEvent</a></td> <td class="imsum_right">retrieves the <a href="KeyEvent.html">KeyEvent</a> for the menu item. </td> </tr> <tr> <td class="imsum_left"><a href="#setHelpText">setHelpText</a></td> <td class="imsum_right">sets the help text for the menu item. </td> </tr> <tr> <td class="imsum_left"><a href="#getHelpText">getHelpText</a></td> <td class="imsum_right">retrieves the help text for the menu item. </td> </tr> <tr> <td class="imsum_left"><a href="#setTipHelpText">setTipHelpText</a></td> <td class="imsum_right">sets the tip help text for the menu item. </td> </tr> <tr> <td class="imsum_left"><a href="#getTipHelpText">getTipHelpText</a></td> <td class="imsum_right">retrieves the tip help text for the menu item. </td> </tr> <tr> <td class="imsum_left"><a href="#setItemImage">setItemImage</a></td> <td class="imsum_right">sets the image for the menu item. </td> </tr> <tr> <td class="imsum_left"><a href="#getItemImage">getItemImage</a></td> <td class="imsum_right">retrieves the image for the menu item. </td> </tr> <tr> <td class="imsum_left"><a href="#setItemImageAngle">setItemImageAngle</a></td> <td class="imsum_right">sets the rotation angle of a menu item image. </td> </tr> <tr> <td class="imsum_left"><a href="#getItemImageAngle">getItemImageAngle</a></td> <td class="imsum_right">retrieves the rotation angle of a menu item image. </td> </tr> <tr> <td class="imsum_left"><a href="#setItemImageMirrorMode">setItemImageMirrorMode</a></td> <td class="imsum_right">sets the mirror mode of a menu item image. </td> </tr> <tr> <td class="imsum_left"><a href="#isItemImageInMirrorMode">isItemImageInMirrorMode</a></td> <td class="imsum_right">indicates whether the menu item image is mirrored. </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="isInExecute" class="membertitle">isInExecute</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>isInExecute</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>queries if the <a href="PopupMenu.html">PopupMenu</a> is being executed as a result of invoking <a href="XPopupMenu.html">XPopupMenu</a>::<a href="XPopupMenu.html#execute">execute()</a>; that is, for a <a href="PopupMenu.html">PopupMenu</a> activated by a <a href="MenuBar.html">MenuBar</a> item, this methods returns <b>false</b>. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the <a href="PopupMenu.html">PopupMenu</a> is being executed, <b>false</b> otherwise. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> <dt><b>See also</b></dt> <dd><a href="XPopupMenu.html">XPopupMenu</a>::<a href="XPopupMenu.html#execute">execute()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="endExecute" class="membertitle">endExecute</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>endExecute</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>ends the execution of the <a href="PopupMenu.html">PopupMenu</a>. <a href="XPopupMenu.html">XPopupMenu</a>::<a href="XPopupMenu.html#execute">execute()</a> will then return 0. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> <dt><b>See also</b></dt> <dd><a href="XPopupMenu.html">XPopupMenu</a>::<a href="XPopupMenu.html#execute">execute()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setLogo" class="membertitle">setLogo</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>setLogo</b>(</td> <td valign="top">[in] <a href="MenuLogo.html">MenuLogo</a></td> <td valign="bottom"> aMenuLogo );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the <a href="MenuLogo.html">MenuLogo</a> for this <a href="PopupMenu.html">PopupMenu</a>. </dd> <dt><b>Parameter aMenuLogo</b></dt> <dd>the <a href="MenuLogo.html">MenuLogo</a>. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLogo" class="membertitle">getLogo</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"><a href="MenuLogo.html">MenuLogo</a></td> </tr> <tr> <td valign="top"><b>getLogo</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the <a href="MenuLogo.html">MenuLogo</a> for this <a href="PopupMenu.html">PopupMenu</a>. </dd> <dt><b>Returns</b></dt> <dd>the <a href="MenuLogo.html">MenuLogo</a>. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="enableAutoMnemonics" class="membertitle">enableAutoMnemonics</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>enableAutoMnemonics</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bEnable );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>specifies whether mnemonics are automatically assigned to menu items, or not. </dd> <dt><b>Parameter bEnable</b></dt> <dd>if <b>true</b>, mnemonics are automatically assigned to menu items. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setAcceleratorKeyEvent" class="membertitle">setAcceleratorKeyEvent</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>setAcceleratorKeyEvent</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nItemId,</td> </tr> <tr> <td/><td valign="top">[in] <a href="KeyEvent.html">KeyEvent</a></td> <td valign="bottom"> aKeyEvent )</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/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the <a href="KeyEvent.html">KeyEvent</a> for the menu item. </dd> <dd><p>The <a href="KeyEvent.html">KeyEvent</a> is <b>only</b> used as a container to transport the shortcut information, this methods only draws the text corresponding to this keyboard shortcut. The client code is responsible for listening to keyboard events (typicaly done via <a href="XUserInputInterception.html">XUserInputInterception</a>), and dispatch the respective command.</p> </dd> <dt><b>Parameter nItemId</b></dt> <dd>specifies the menu item identifier for which the <a href="KeyEvent.html">KeyEvent</a> should be set. </dd> <dt><b>Parameter aKeyEvent</b></dt> <dd>specifies the <a href="KeyEvent.html">KeyEvent</a> for the menu item. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> if there is no menu item with the identifier specified in <var>nItemId</var>. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAcceleratorKeyEvent" class="membertitle">getAcceleratorKeyEvent</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"><a href="KeyEvent.html">KeyEvent</a></td> </tr> <tr> <td valign="top"><b>getAcceleratorKeyEvent</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nItemId )</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/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the <a href="KeyEvent.html">KeyEvent</a> for the menu item. </dd> <dd><p>The <a href="KeyEvent.html">KeyEvent</a> is <b>only</b> used as a container to transport the shortcut information, so that in this case ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/EventObject.html">EventObject</a>::<a href="../lang/EventObject.html#Source">Source</a> is <b>NULL</b>.</p> </dd> <dt><b>Parameter nItemId</b></dt> <dd>specifies the menu item identifier for which the <a href="KeyEvent.html">KeyEvent</a> should be retrieved. </dd> <dt><b>Returns</b></dt> <dd>the <a href="KeyEvent.html">KeyEvent</a> struct assigned to the requested menu item. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> if there is no menu item with the identifier specified in <var>nItemId</var>. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setHelpText" class="membertitle">setHelpText</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>setHelpText</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nItemId,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> sHelpText )</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/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the help text for the menu item. </dd> <dt><b>Parameter nItemId</b></dt> <dd>specifies the menu item identifier for which the help text should be set. </dd> <dt><b>Parameter sHelpText</b></dt> <dd>specifies the help text for the menu item. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> if there is no menu item with the identifier specified in <var>nItemId</var>. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getHelpText" class="membertitle">getHelpText</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>getHelpText</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nItemId )</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/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the help text for the menu item. </dd> <dt><b>Parameter nItemId</b></dt> <dd>specifies the menu item identifier for which the help text should be retrieved. </dd> <dt><b>Returns</b></dt> <dd>a string with the help text. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> if there is no menu item with the identifier specified in <var>nItemId</var>. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setTipHelpText" class="membertitle">setTipHelpText</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>setTipHelpText</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nItemId,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> sTipHelpText )</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/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the tip help text for the menu item. </dd> <dt><b>Parameter nItemId</b></dt> <dd>specifies the menu item identifier for which the tip help text should be set. </dd> <dt><b>Parameter sTipHelpText</b></dt> <dd>specifies the tip help text for the menu item. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> if there is no menu item with the identifier specified in <var>nItemId</var>. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getTipHelpText" class="membertitle">getTipHelpText</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>getTipHelpText</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nItemId )</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/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the tip help text for the menu item. </dd> <dt><b>Parameter nItemId</b></dt> <dd>specifies the menu item identifier for which the tip help text should be retrieved. </dd> <dt><b>Returns</b></dt> <dd>a string with the tip help text. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> if there is no menu item with the identifier specified in <var>nItemId</var>. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setItemImage" class="membertitle">setItemImage</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>setItemImage</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nItemId,</td> </tr> <tr> <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"> xGraphic,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bScale )</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/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the image for the menu item. </dd> <dt><b>Parameter nItemId</b></dt> <dd>specifies the menu item identifier for which the image should be set. </dd> <dt><b>Parameter xGraphic</b></dt> <dd>specifies the image for the menu item. </dd> <dt><b>Parameter bScale</b></dt> <dd>if <b>true</b>, the image will be scaled to the standard size used internally by the implementation. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> if there is no menu item with the identifier specified in <var>nItemId</var>. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getItemImage" class="membertitle">getItemImage</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">::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>getItemImage</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nItemId )</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/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the image for the menu item. </dd> <dt><b>Parameter nItemId</b></dt> <dd>specifies the menu item identifier for which the image should be retrieved. </dd> <dt><b>Returns</b></dt> <dd>a ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a> reference to the current image for the requested menu item. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> if there is no menu item with the identifier specified in <var>nItemId</var>. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setItemImageAngle" class="membertitle">setItemImageAngle</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>setItemImageAngle</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nItemId,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nAngle )</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/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the rotation angle of a menu item image. </dd> <dt><b>Parameter nItemId</b></dt> <dd>specifies the menu item identifier for which the image angle should be set. </dd> <dt><b>Parameter nAngle</b></dt> <dd>specifies the rotation angle for the menu item image. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> if there is no menu item with the identifier specified in <var>nItemId</var>. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getItemImageAngle" class="membertitle">getItemImageAngle</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>getItemImageAngle</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nItemId )</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/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the rotation angle of a menu item image. </dd> <dt><b>Parameter nItemId</b></dt> <dd>specifies the menu item identifier for which the rotation angle should be retrieved. </dd> <dt><b>Returns</b></dt> <dd>the rotation angle of the menu item image, or 0 if it has no rotation. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> if there is no menu item with the identifier specified in <var>nItemId</var>. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setItemImageMirrorMode" class="membertitle">setItemImageMirrorMode</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>setItemImageMirrorMode</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nItemId,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bMirror )</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/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the mirror mode of a menu item image. </dd> <dt><b>Parameter nItemId</b></dt> <dd>specifies the menu item identifier for which the mirror mode should be set. </dd> <dt><b>Parameter bMirror</b></dt> <dd>if <b>true</b>, the item image is mirrored. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> if there is no menu item with the identifier specified in <var>nItemId</var>. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isItemImageInMirrorMode" class="membertitle">isItemImageInMirrorMode</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>isItemImageInMirrorMode</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nItemId )</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/NoSuchElementException.html">NoSuchElementException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>indicates whether the menu item image is mirrored. </dd> <dt><b>Parameter nItemId</b></dt> <dd>specifies the menu item identifier for which the image mirror mode should be checked. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the item image is mirrored, <b>false</b> otherwise. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> if there is no menu item with the identifier specified in <var>nItemId</var>. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 3.1</dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
1176
