<html> <head> <title>Interface XCommandInfo</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="XCommandInfo-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">ucb</a> :: </p> </td> </tr> <tr> <td class="title">interface XCommandInfo</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides access to information on a set of commands. </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="#getCommands">getCommands</a></td> <td class="imsum_right">obtains information for all supported commands. </td> </tr> <tr> <td class="imsum_left"><a href="#getCommandInfoByName">getCommandInfoByName</a></td> <td class="imsum_right">returns information for a specific command. </td> </tr> <tr> <td class="imsum_left"><a href="#getCommandInfoByHandle">getCommandInfoByHandle</a></td> <td class="imsum_right">returns information for a specific command. </td> </tr> <tr> <td class="imsum_left"><a href="#hasCommandByName">hasCommandByName</a></td> <td class="imsum_right">checks whether a command specific is supported. </td> </tr> <tr> <td class="imsum_left"><a href="#hasCommandByHandle">hasCommandByHandle</a></td> <td class="imsum_right">checks whether a specific command is supported. </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="getCommands" class="membertitle">getCommands</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< <a href="CommandInfo.html">CommandInfo</a> ></td> </tr> <tr> <td valign="top"><b>getCommands</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>obtains information for all supported commands. </dd> <dt><b>Returns</b></dt> <dd>a sequence with information for all supported commands. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCommandInfoByName" class="membertitle">getCommandInfoByName</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="CommandInfo.html">CommandInfo</a></td> </tr> <tr> <td valign="top"><b>getCommandInfoByName</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> Name )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="UnsupportedCommandException.html">UnsupportedCommandException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns information for a specific command. </dd> <dt><b>Returns</b></dt> <dd>the information for the requested command. </dd> <dt><b>Parameter Name</b></dt> <dd>specifies the name of the requested command. </dd> <dt><b>Throws</b></dt> <dd>UnsupportedCommandException if the command is not supported. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCommandInfoByHandle" class="membertitle">getCommandInfoByHandle</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="CommandInfo.html">CommandInfo</a></td> </tr> <tr> <td valign="top"><b>getCommandInfoByHandle</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> Handle )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="UnsupportedCommandException.html">UnsupportedCommandException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns information for a specific command. </dd> <dt><b>Returns</b></dt> <dd>the information for the requested command. </dd> <dt><b>Parameter Handle</b></dt> <dd>specifies the handle of the requested command. </dd> <dt><b>Throws</b></dt> <dd>UnsupportedCommandException if the command is not supported. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasCommandByName" class="membertitle">hasCommandByName</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>hasCommandByName</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> Name );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>checks whether a command specific is supported. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if a command with the specified name is supported; otherwise <b>false</b> is returned. </dd> <dt><b>Parameter Name</b></dt> <dd>specifies the name of the requested command. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="hasCommandByHandle" class="membertitle">hasCommandByHandle</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>hasCommandByHandle</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> Handle );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>checks whether a specific command is supported. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if a command with the specified handle is supported; otherwise <b>false</b> is returned. </dd> <dt><b>Parameter Name</b></dt> <dd>specifies the handle of the requested command. </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>
