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

LibreOffice LibreOffice 25.8 SDK API Reference

Loading...
Searching...
No Matches
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
20
21 module com { module sun { module star { module frame {
22
23 published interface XFrameActionListener;
24 published interface XController;
25 published interface XFramesSupplier;
26
38published interface XFrame: com::sun::star::lang::XComponent
39{
58 void initialize( [in] com::sun::star::awt::XWindow xWindow );
59
72 com::sun::star::awt::XWindow getContainerWindow();
73
89 void setCreator( [in] XFramesSupplier Creator );
90
98 XFramesSupplier getCreator();
99
107 string getName();
108
132 void setName( [in] string aName );
133
176 XFrame findFrame(
177 [in] string aTargetFrameName,
178 [in] long nSearchFlags);
179
194 boolean isTop();
195
215 void activate();
216
228 void deactivate();
229
240 boolean isActive();
241
269 boolean setComponent(
270 [in] com::sun::star::awt::XWindow xComponentWindow,
271 [in] XController xController);
272
286 com::sun::star::awt::XWindow getComponentWindow();
287
304 XController getController();
305
320 void contextChanged();
321
335 void addFrameActionListener( [in]XFrameActionListener xListener );
336
344 void removeFrameActionListener( [in] XFrameActionListener xListener );
345};
346
347
348}; }; }; };
349
350/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::awt::XWindow
specifies the basic operations for a window component.
Definition XWindow.idl:33
com::sun::star::frame::XController
With this interface, components viewed in a Frame can serve events (by supplying dispatches).
Definition XController.idl:34
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:36
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:39
com::sun::star::frame::XFrame::getName
string getName()
access to the name property of this frame
com::sun::star::frame::XFrame::getCreator
XFramesSupplier getCreator()
provides access to the creator (parent) of this frame
com::sun::star::frame::XFrame::getContainerWindow
com::sun::star::awt::XWindow getContainerWindow()
provides access to the container window of the frame.
com::sun::star::frame::XFrame::getComponentWindow
com::sun::star::awt::XWindow getComponentWindow()
provides access to the component window
com::sun::star::frame::XFrame::setCreator
void setCreator([in] XFramesSupplier Creator)
sets the frame container that created this frame.
com::sun::star::frame::XFrame::isActive
boolean isActive()
determines if the frame is active.
com::sun::star::frame::XFrame::isTop
boolean isTop()
determines if the frame is a top frame.
com::sun::star::frame::XFrame::activate
void activate()
activates this frame and thus the component within.
com::sun::star::frame::XFrame::deactivate
void deactivate()
is called by the creator frame when another sub-frame gets activated.
com::sun::star::frame::XFrame::getController
XController getController()
provides access to the controller
com::sun::star::frame::XFrame::addFrameActionListener
void addFrameActionListener([in]XFrameActionListener xListener)
registers an event listener, which will be called when certain things happen to the components within...
com::sun::star::frame::XFrame::setComponent
boolean setComponent([in] com::sun::star::awt::XWindow xComponentWindow, [in] XController xController)
sets a new component into the frame or release an existing one from a frame.
com::sun::star::frame::XFrame::contextChanged
void contextChanged()
notifies the frame that the context of the controller within this frame changed (i....
com::sun::star::frame::XFrame::initialize
void initialize([in] com::sun::star::awt::XWindow xWindow)
is called to initialize the frame within a window - the container window.
com::sun::star::frame::XFrame::removeFrameActionListener
void removeFrameActionListener([in] XFrameActionListener xListener)
unregisters an event listener
com::sun::star::frame::XFrame::setName
void setName([in] string aName)
sets the name of the frame.
com::sun::star::frame::XFrame::findFrame
XFrame findFrame([in] string aTargetFrameName, [in] long nSearchFlags)
searches for a frame with the specified name.
com::sun::star::frame::XFramesSupplier
provides access to sub frames of current one
Definition XFramesSupplier.idl:30
com::sun::star::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition XComponent.idl:39
com
Definition Ambiguous.idl:20