offapi/com/sun/star/ucb/XCommandInfo.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_XCommandInfo_idl__
  20 #define __com_sun_star_ucb_XCommandInfo_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/ucb/CommandInfo.idl>
  24 #include <com/sun/star/ucb/UnsupportedCommandException.idl>
  25
  26
  27
  28 module com { module sun { module star { module ucb {
  29
  30 /** provides access to information on a set of commands.
  31
  32     @version  1.0
  33     @author   Kai Sommerfeld
  34 */
  35 published interface XCommandInfo: com::sun::star::uno::XInterface
  36 {
  37     /** obtains information for all supported commands.
  38
  39         @returns
  40         a sequence with information for all supported commands.
  41     */
  42     sequence<com::sun::star::ucb::CommandInfo> getCommands();
  43
  44     /** returns information for a specific command.
  45
  46         @returns
  47         the information for the requested command.
  48
  49         @param Name
  50         specifies the name of the requested command.
  51
  52         @throws UnsupportedCommandException
  53         if the command is not supported.
  54     */
  55     com::sun::star::ucb::CommandInfo getCommandInfoByName( [in] string Name )
  56             raises( com::sun::star::ucb::UnsupportedCommandException );
  57
  58     /** returns information for a specific command.
  59
  60         @returns
  61         the information for the requested command.
  62
  63         @param Handle
  64         specifies the handle of the requested command.
  65
  66         @throws UnsupportedCommandException
  67         if the command is not supported.
  68     */
  69     com::sun::star::ucb::CommandInfo getCommandInfoByHandle( [in] long Handle )
  70             raises( com::sun::star::ucb::UnsupportedCommandException );
  71
  72     /** checks whether a command specific is supported.
  73
  74         @returns
  75         `TRUE` if a command with the specified name is supported;
  76         otherwise `FALSE` is returned.
  77
  78         @param Name
  79         specifies the name of the requested command.
  80     */
  81     boolean hasCommandByName( [in] string Name );
  82
  83     /** checks whether a specific command is supported.
  84
  85         @returns
  86         `TRUE` if a command with the specified handle is supported;
  87         otherwise `FALSE` is returned.
  88
  89         @param Handle
  90         specifies the handle of the requested command.
  91     */
  92     boolean hasCommandByHandle( [in] long Handle );
  93
  94 };
  95
  96
  97 }; }; }; };
  98
  99 #endif
 100
 101 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */