LibreOffice LibreOffice 25.8 SDK API Reference

XEventAttacherManager.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
20
21
22 module com { module sun { module star { module script {
23
26published interface XEventAttacherManager: com::sun::star::uno::XInterface
27{
38 void registerScriptEvent( [in] long nIndex,
39 [in] com::sun::star::script::ScriptEventDescriptor aScriptEvent )
40 raises( com::sun::star::lang::IllegalArgumentException );
41
60 void registerScriptEvents( [in] long nIndex,
61 [in] sequence<com::sun::star::script::ScriptEventDescriptor> aScriptEvents )
62 raises( com::sun::star::lang::IllegalArgumentException );
63
81 void revokeScriptEvent( [in] long nIndex,
82 [in] string aListenerType,
83 [in] string aEventMethod,
84 [in] string aRemoveListenerParam )
85 raises( com::sun::star::lang::IllegalArgumentException );
86
95 void revokeScriptEvents( [in] long nIndex )
96 raises( com::sun::star::lang::IllegalArgumentException );
97
103 void insertEntry( [in] long nIndex )
104 raises( com::sun::star::lang::IllegalArgumentException );
105
115 void removeEntry( [in] long nIndex )
116 raises( com::sun::star::lang::IllegalArgumentException );
117
127 sequence<com::sun::star::script::ScriptEventDescriptor> getScriptEvents( [in] long Index )
128 raises( com::sun::star::lang::IllegalArgumentException );
129
139 void attach( [in] long nIndex,
140 [in] com::sun::star::uno::XInterface xObject,
141 [in] any aHelper )
142 raises( com::sun::star::lang::IllegalArgumentException,
143 com::sun::star::lang::ServiceNotRegisteredException );
144
154 void detach( [in] long nIndex,
155 [in] com::sun::star::uno::XInterface xObject )
156 raises( com::sun::star::lang::IllegalArgumentException );
157
168 void addScriptListener( [in] com::sun::star::script::XScriptListener xListener )
169 raises( com::sun::star::lang::IllegalArgumentException );
170
180 void removeScriptListener( [in] com::sun::star::script::XScriptListener Listener )
181 raises( com::sun::star::lang::IllegalArgumentException );
182
183};
184
185
186}; }; }; };
187
188/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
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::lang::ServiceNotRegisteredException
This exception is thrown when a needed service is not found.
Definition: ServiceNotRegisteredException.idl:30
com::sun::star::script::XEventAttacherManager
registers listeners for specified events.
Definition: XEventAttacherManager.idl:27
com::sun::star::script::XEventAttacherManager::registerScriptEvent
void registerScriptEvent([in] long nIndex, [in] com::sun::star::script::ScriptEventDescriptor aScriptEvent)
registers one event for an object identified by its index.
com::sun::star::script::XEventAttacherManager::insertEntry
void insertEntry([in] long nIndex)
creates an empty entry at the given position.
com::sun::star::script::XEventAttacherManager::removeScriptListener
void removeScriptListener([in] com::sun::star::script::XScriptListener Listener)
removes a XScriptListener from the listener list.
com::sun::star::script::XEventAttacherManager::detach
void detach([in] long nIndex, [in] com::sun::star::uno::XInterface xObject)
detaches all the ScriptEvents from the given object which are registered at this object for the given...
com::sun::star::script::XEventAttacherManager::removeEntry
void removeEntry([in] long nIndex)
removes the entry at the given position.
com::sun::star::script::XEventAttacherManager::registerScriptEvents
void registerScriptEvents([in] long nIndex, [in] sequence< com::sun::star::script::ScriptEventDescriptor > aScriptEvents)
registers several events for an object identified by its index.
com::sun::star::script::XEventAttacherManager::revokeScriptEvents
void revokeScriptEvents([in] long nIndex)
revokes all events which are registered for the given index.
com::sun::star::script::XEventAttacherManager::revokeScriptEvent
void revokeScriptEvent([in] long nIndex, [in] string aListenerType, [in] string aEventMethod, [in] string aRemoveListenerParam)
revokes the registration of an event.
com::sun::star::script::XEventAttacherManager::addScriptListener
void addScriptListener([in] com::sun::star::script::XScriptListener xListener)
adds an XScriptListener that will be notified when an event takes place.
com::sun::star::script::XEventAttacherManager::attach
void attach([in] long nIndex, [in] com::sun::star::uno::XInterface xObject, [in] any aHelper)
attaches all the ScriptEvents which are registered for the given index to the given object.
com::sun::star::script::XEventAttacherManager::getScriptEvents
sequence< com::sun::star::script::ScriptEventDescriptor > getScriptEvents([in] long Index)
com::sun::star::script::XScriptListener
makes it possible to receive ScriptEvents.
Definition: XScriptListener.idl:27
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20
com::sun::star::script::ScriptEventDescriptor
describes an effect, especially a script to be executed, for a certain event given by the listener ty...
Definition: ScriptEventDescriptor.idl:29