LibreOffice: com/sun/star/frame/XFrame.idl Source File

LibreOffice LibreOffice 5.4 SDK API Reference

XFrame.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_frame_XFrame_idl__
20 #define __com_sun_star_frame_XFrame_idl__
21
22 #include <com/sun/star/lang/XComponent.idl>
23 #include <com/sun/star/awt/XWindow.idl>
24
25
26 module com { module sun { module star { module frame {
27
28 published interface XFrameActionListener;
29 published interface XController;
30 published interface XFramesSupplier;
31
43 published interface XFrame: com::sun::star::lang::XComponent
44 {
63 void initialize( [in] com::sun::star::awt::XWindow xWindow );
64
77 com::sun::star::awt::XWindow getContainerWindow();
78
94 void setCreator( [in] XFramesSupplier Creator );
95
103 XFramesSupplier getCreator();
104
112 string getName();
113
137 void setName( [in] string aName );
138
181 XFrame findFrame(
182 [in] string aTargetFrameName,
183 [in] long nSearchFlags);
184
199 boolean isTop();
200
220 void activate();
221
233 void deactivate();
234
245 boolean isActive();
246
274 boolean setComponent(
275 [in] com::sun::star::awt::XWindow xComponentWindow,
276 [in] XController xController);
277
291 com::sun::star::awt::XWindow getComponentWindow();
292
309 XController getController();
310
325 void contextChanged();
326
340 void addFrameActionListener( [in]XFrameActionListener xListener );
341
349 void removeFrameActionListener( [in] XFrameActionListener xListener );
350 };
351
352
353 }; }; }; };
354
355 #endif
356
357 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::lang::XComponent
allows to exclicitly free resources and break cyclic references.
Definition: XComponent.idl:42
com
Definition: Ambiguous.idl:22
com::sun::star::awt::XWindow
specifies the basic operations for a window component.
Definition: XWindow.idl:50
com::sun::star::frame::XController
With this interface, components viewed in a Frame can serve events (by supplying dispatches).
Definition: XController.idl:37
XComponent.idl
com::sun::star::frame::XFrame
a frame object can be considered to be an "anchor" object where a component can be attached to...
Definition: XFrame.idl:43
XWindow.idl
com::sun::star::frame::XFramesSupplier
provides access to sub frames of current one
Definition: XFramesSupplier.idl:33
com::sun::star::frame::XFrameActionListener
has to be provided if an object wants to receive events when several things happen to components with...
Definition: XFrameActionListener.idl:40