LibreOffice LibreOffice 25.2 SDK API Reference

XInplaceClient.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 embed {
23
26 interface XInplaceClient: com::sun::star::uno::XInterface
27{
34 boolean canInplaceActivate();
35
42 void activatingInplace()
43 raises( ::com::sun::star::embed::WrongStateException );
44
51 void activatingUI()
52 raises( ::com::sun::star::embed::WrongStateException );
53
59 void deactivatedInplace()
60 raises( ::com::sun::star::embed::WrongStateException );
61
72 void deactivatedUI()
73 raises( ::com::sun::star::embed::WrongStateException );
74
87 ::com::sun::star::frame::XLayoutManager getLayoutManager()
88 raises( ::com::sun::star::embed::WrongStateException );
89
99 ::com::sun::star::frame::XDispatchProvider getInplaceDispatchProvider()
100 raises( ::com::sun::star::embed::WrongStateException );
101
118 ::com::sun::star::awt::Rectangle getPlacement()
119 raises( ::com::sun::star::embed::WrongStateException );
120
135 ::com::sun::star::awt::Rectangle getClipRectangle()
136 raises( ::com::sun::star::embed::WrongStateException );
137
147 void translateAccelerators( [in] sequence< ::com::sun::star::awt::KeyEvent > aKeys )
148 raises( ::com::sun::star::embed::WrongStateException );
149
158 void scrollObject( [in] ::com::sun::star::awt::Size aOffset )
159 raises( ::com::sun::star::embed::WrongStateException );
160
172 void changedPlacement( [in] ::com::sun::star::awt::Rectangle aPosRect )
173 raises( ::com::sun::star::embed::WrongStateException,
174 ::com::sun::star::uno::Exception );
175};
176
177
178}; }; }; };
179
180/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::embed::WrongStateException
This exception can be thrown in case the object's state does not allow to call requested functionalit...
Definition: WrongStateException.idl:29
com::sun::star::embed::XInplaceClient
represents common functionality for inplace clients.
Definition: XInplaceClient.idl:27
com::sun::star::embed::XInplaceClient::activatingInplace
void activatingInplace()
notifies container through the client that the object is to be inplace activated.
com::sun::star::embed::XInplaceClient::canInplaceActivate
boolean canInplaceActivate()
checks if the container can activate the object inplace.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20