LibreOffice LibreOffice 24.2 SDK API Reference

Loading...
Searching...
No Matches
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
20module com { module sun { module star { module ui {
21
47published interface XAcceleratorConfiguration
48{
66 sequence< com::sun::star::awt::KeyEvent > getAllKeyEvents();
67
89 string getCommandByKeyEvent( [in] com::sun::star::awt::KeyEvent aKeyEvent )
90 raises(com::sun::star::container::NoSuchElementException);
91
126 void setKeyEvent( [in] com::sun::star::awt::KeyEvent aKeyEvent,
127 [in] string sCommand )
128 raises(com::sun::star::lang::IllegalArgumentException,
129 com::sun::star::container::NoSuchElementException);
130
139 void removeKeyEvent( [in] com::sun::star::awt::KeyEvent aKeyEvent )
140 raises(com::sun::star::container::NoSuchElementException);
141
166 sequence< com::sun::star::awt::KeyEvent > getKeyEventsByCommand( [in] string sCommand )
167 raises(com::sun::star::lang::IllegalArgumentException ,
168 com::sun::star::container::NoSuchElementException);
169
206 sequence< any > getPreferredKeyEventsForCommandList( [in] sequence< string > lCommandList )
207 raises(com::sun::star::lang::IllegalArgumentException,
208 com::sun::star::container::NoSuchElementException);
209
235 void removeCommandFromAllKeyEvents( [in] string sCommand )
236 raises(com::sun::star::lang::IllegalArgumentException ,
237 com::sun::star::container::NoSuchElementException);
238
243 interface com::sun::star::ui::XUIConfigurationPersistence;
244
250 interface com::sun::star::ui::XUIConfigurationStorage;
251
255 interface com::sun::star::ui::XUIConfiguration;
256
257}; // interface XAcceleratorConfiguration
258
259}; }; }; }; // com.sun.star
260
261/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition NoSuchElementException.idl:31
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition IllegalArgumentException.idl:27
com::sun::star::ui::XAcceleratorConfiguration
provides read/write access to an accelerator configuration set.
Definition XAcceleratorConfiguration.idl:48
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:30
com::sun::star::ui::XUIConfigurationStorage
supplies functions to change or get information about the storage of a user interface configuration m...
Definition XUIConfigurationStorage.idl:31
com::sun::star::ui::XUIConfiguration
supports to notify other implementations about changes of a user interface configuration manager.
Definition XUIConfiguration.idl:39
com
Definition Ambiguous.idl:20
com::sun::star::awt::KeyEvent
specifies a key event.
Definition KeyEvent.idl:30