LibreOffice LibreOffice 7.2 SDK API Reference

XAcceleratorConfiguration.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_ui_XAcceleratorConfiguration_idl__
20#define __com_sun_star_ui_XAcceleratorConfiguration_idl__
21
22#include <com/sun/star/ui/XUIConfiguration.idl>
23#include <com/sun/star/ui/XUIConfigurationPersistence.idl>
24#include <com/sun/star/ui/XUIConfigurationStorage.idl>
25#include <com/sun/star/awt/KeyEvent.idl>
26#include <com/sun/star/lang/IllegalArgumentException.idl>
27#include <com/sun/star/container/NoSuchElementException.idl>
28
29module com { module sun { module star { module ui {
30
56published interface XAcceleratorConfiguration
57{
75 sequence< com::sun::star::awt::KeyEvent > getAllKeyEvents();
76
98 string getCommandByKeyEvent( [in] com::sun::star::awt::KeyEvent aKeyEvent )
99 raises(com::sun::star::container::NoSuchElementException);
100
135 void setKeyEvent( [in] com::sun::star::awt::KeyEvent aKeyEvent,
136 [in] string sCommand )
137 raises(com::sun::star::lang::IllegalArgumentException,
138 com::sun::star::container::NoSuchElementException);
139
148 void removeKeyEvent( [in] com::sun::star::awt::KeyEvent aKeyEvent )
149 raises(com::sun::star::container::NoSuchElementException);
150
175 sequence< com::sun::star::awt::KeyEvent > getKeyEventsByCommand( [in] string sCommand )
176 raises(com::sun::star::lang::IllegalArgumentException ,
177 com::sun::star::container::NoSuchElementException);
178
215 sequence< any > getPreferredKeyEventsForCommandList( [in] sequence< string > lCommandList )
216 raises(com::sun::star::lang::IllegalArgumentException,
217 com::sun::star::container::NoSuchElementException);
218
244 void removeCommandFromAllKeyEvents( [in] string sCommand )
245 raises(com::sun::star::lang::IllegalArgumentException ,
246 com::sun::star::container::NoSuchElementException);
247
252 interface com::sun::star::ui::XUIConfigurationPersistence;
253
259 interface com::sun::star::ui::XUIConfigurationStorage;
260
264 interface com::sun::star::ui::XUIConfiguration;
265
266}; // interface XAcceleratorConfiguration
267
268}; }; }; }; // com.sun.star
269
270#endif
271
272/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
IllegalArgumentException.idl
KeyEvent.idl
NoSuchElementException.idl
XUIConfigurationPersistence.idl
XUIConfigurationStorage.idl
XUIConfiguration.idl
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:35
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
com::sun::star::ui::XAcceleratorConfiguration
provides read/write access to an accelerator configuration set.
Definition: XAcceleratorConfiguration.idl:57
com::sun::star::ui::XAcceleratorConfiguration::getPreferredKeyEventsForCommandList
sequence< any > getPreferredKeyEventsForCommandList([in] sequence< string > lCommandList)
optimized function to map a list of commands to a corresponding list of key events.
com::sun::star::ui::XAcceleratorConfiguration::setKeyEvent
void setKeyEvent([in] com::sun::star::awt::KeyEvent aKeyEvent, [in] string sCommand)
modify or create a key - command - binding.
com::sun::star::ui::XAcceleratorConfiguration::removeCommandFromAllKeyEvents
void removeCommandFromAllKeyEvents([in] string sCommand)
search for a key-command-binding inside this configuration set, where the specified command is used.
com::sun::star::ui::XAcceleratorConfiguration::getKeyEventsByCommand
sequence< com::sun::star::awt::KeyEvent > getKeyEventsByCommand([in] string sCommand)
optimized access to the relation "command-key" instead of "key-command" which is provided normally by...
com::sun::star::ui::XAcceleratorConfiguration::getCommandByKeyEvent
string getCommandByKeyEvent([in] com::sun::star::awt::KeyEvent aKeyEvent)
return the registered command for the specified key event.
com::sun::star::ui::XAcceleratorConfiguration::removeKeyEvent
void removeKeyEvent([in] com::sun::star::awt::KeyEvent aKeyEvent)
remove a key-command-binding from this configuration set.
com::sun::star::ui::XAcceleratorConfiguration::getAllKeyEvents
sequence< com::sun::star::awt::KeyEvent > getAllKeyEvents()
return the list of all key events, which are available at this configuration set.
com::sun::star::ui::XUIConfigurationPersistence
specifies a persistence interface which supports to load/store user interface configuration data to a...
Definition: XUIConfigurationPersistence.idl:35
com::sun::star::ui::XUIConfigurationStorage
supplies functions to change or get information about the storage of a user interface configuration m...
Definition: XUIConfigurationStorage.idl:36
com::sun::star::ui::XUIConfiguration
supports to notify other implementations about changes of a user interface configuration manager.
Definition: XUIConfiguration.idl:44
com
Definition: Accessible.idl:22
com::sun::star::awt::KeyEvent
specifies a key event.
Definition: KeyEvent.idl:34