LibreOffice: com/sun/star/ucb/XCommandInfo.idl Source File

LibreOffice LibreOffice 7.3 SDK API Reference

XCommandInfo.idl
Go to the documentation of this file.
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
28module com { module sun { module star { module ucb {
29
34published interface XCommandInfo: com::sun::star::uno::XInterface
35{
41 sequence<com::sun::star::ucb::CommandInfo> getCommands();
42
54 com::sun::star::ucb::CommandInfo getCommandInfoByName( [in] string Name )
55 raises( com::sun::star::ucb::UnsupportedCommandException );
56
68 com::sun::star::ucb::CommandInfo getCommandInfoByHandle( [in] long Handle )
69 raises( com::sun::star::ucb::UnsupportedCommandException );
70
80 boolean hasCommandByName( [in] string Name );
81
91 boolean hasCommandByHandle( [in] long Handle );
92
93};
94
95
96}; }; }; };
97
98#endif
99
100/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
CommandInfo.idl
UnsupportedCommandException.idl
XInterface.idl
com::sun::star::ucb::UnsupportedCommandException
is thrown to indicate that a command is not known by the implementation of an interface.
Definition: UnsupportedCommandException.idl:35
com::sun::star::ucb::XCommandInfo
provides access to information on a set of commands.
Definition: XCommandInfo.idl:35
com::sun::star::ucb::XCommandInfo::getCommands
sequence< com::sun::star::ucb::CommandInfo > getCommands()
obtains information for all supported commands.
com::sun::star::ucb::XCommandInfo::getCommandInfoByName
com::sun::star::ucb::CommandInfo getCommandInfoByName([in] string Name)
returns information for a specific command.
com::sun::star::ucb::XCommandInfo::hasCommandByName
boolean hasCommandByName([in] string Name)
checks whether a command specific is supported.
com::sun::star::ucb::XCommandInfo::getCommandInfoByHandle
com::sun::star::ucb::CommandInfo getCommandInfoByHandle([in] long Handle)
returns information for a specific command.
com::sun::star::ucb::XCommandInfo::hasCommandByHandle
boolean hasCommandByHandle([in] long Handle)
checks whether a specific command is supported.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com
Definition: Accessible.idl:22
com::sun::star::ucb::CommandInfo
describes a command.
Definition: CommandInfo.idl:33