LibreOffice
LibreOffice 24.8 SDK API Reference
Loading...
Searching...
No Matches
XLayoutManager.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
21module com { module sun { module star { module frame {
22
23
57{
69
82 void reset();
83
97
110
125
133 void createElement( [in] string ResourceURL );
134
142 void destroyElement( [in] string ResourceURL );
143
163 boolean requestElement( [in] string ResourceURL );
164
177 com::sun::star::ui::XUIElement getElement( [in] string ResourceURL );
178
190 sequence< com::sun::star::ui::XUIElement > getElements();
191
202 boolean showElement( [in] string ResourceURL );
203
214 boolean hideElement( [in] string ResourceURL );
215
234 boolean dockWindow( [in] string ResourceURL, [in] com::sun::star::ui::DockingArea DockingArea, [in] com::sun::star::awt::Point Pos );
235
247 boolean dockAllWindows( [in] short nElementType );
248
259 boolean floatWindow( [in] string ResourceURL );
260
271 boolean lockWindow( [in] string ResourceURL );
272
284 boolean unlockWindow( [in] string ResourceURL );
285
301 void setElementSize( [in] string ResourceURL, [in] com::sun::star::awt::Size Size );
302
318 void setElementPos( [in] string ResourceURL, [in] com::sun::star::awt::Point Pos );
319
338 void setElementPosSize( [in] string ResourceURL, [in] com::sun::star::awt::Point Pos, [in] com::sun::star::awt::Size Size );
339
350 boolean isElementVisible( [in] string ResourceURL );
351
362 boolean isElementFloating( [in] string ResourceURL );
363
374 boolean isElementDocked( [in] string ResourceURL );
375
386 boolean isElementLocked( [in] string ResourceURL );
387
398 com::sun::star::awt::Size getElementSize( [in] string ResourceURL );
399
410 com::sun::star::awt::Point getElementPos( [in] string ResourceURL );
411
419 void lock();
420
428 void unlock();
429
432 void doLayout();
433
447 void setVisible( [in] boolean Visible );
448
459 boolean isVisible();
460
461};
462
463}; }; }; };
464
465/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
a frame object can be considered to be an "anchor" object where a component can be attached to.
Definition generated_idl_chapter_refs.idl:891
central interface to query for, create, destroy and manipulate user interface elements which are boun...
Definition XLayoutManager.idl:57
void destroyElement([in] string ResourceURL)
destroys a user interface element.
boolean isElementDocked([in] string ResourceURL)
retrieves the current docking state of a window based user interface element.
com::sun::star::awt::Rectangle getCurrentDockingArea()
provides the current docking area size of the layout manager.
void createElement([in] string ResourceURL)
creates a new user interface element.
void setElementPos([in] string ResourceURL, [in] com::sun::star::awt::Point Pos)
sets a new position for a window based user interface element.
com::sun::star::awt::Point getElementPos([in] string ResourceURL)
retrieves the current pixel position of a window based user interface element.
boolean hideElement([in] string ResourceURL)
hides a user interface element.
com::sun::star::ui::XDockingAreaAcceptor getDockingAreaAcceptor()
retrieves the current docking area acceptor that controls the border space of the frame's container w...
boolean dockWindow([in] string ResourceURL, [in] com::sun::star::ui::DockingArea DockingArea, [in] com::sun::star::awt::Point Pos)
docks a window based user interface element to a specified docking area.
boolean isElementFloating([in] string ResourceURL)
retrieves the current floating state of a window based user interface element.
void setElementSize([in] string ResourceURL, [in] com::sun::star::awt::Size Size)
sets a new size for a window based user interface element.
boolean isElementVisible([in] string ResourceURL)
retrieves the current visibility state of a window based user interface element.
boolean showElement([in] string ResourceURL)
shows a user interface element.
boolean isVisible()
retrieves the visibility state of a layout manager.
boolean isElementLocked([in] string ResourceURL)
retrieves the current lock state of a window based user interface element.
void setElementPosSize([in] string ResourceURL, [in] com::sun::star::awt::Point Pos, [in] com::sun::star::awt::Size Size)
sets a new position and size for a window based user interface element.
void unlock()
permit layout updates again.
void setDockingAreaAcceptor([in] com::sun::star::ui::XDockingAreaAcceptor xDockingAreaAcceptor)
sets a docking area acceptor that controls the border space of the frame's container window.
void attachFrame([in] com::sun::star::frame::XFrame Frame)
attaches a com::sun::star::frame::XFrame to a layout manager.
boolean requestElement([in] string ResourceURL)
request to make a user interface element visible if it is not in hidden state.
sequence< com::sun::star::ui::XUIElement > getElements()
retrieves all user interface elements which are currently instantiated.
void lock()
prohibit all layout updates until unlock is called again.
com::sun::star::awt::Size getElementSize([in] string ResourceURL)
retrieves the current size of a window based user interface element.
void doLayout()
forces a complete new layouting of all user interface elements.
boolean lockWindow([in] string ResourceURL)
locks a window based user interface element if it's in a docked state.
boolean unlockWindow([in] string ResourceURL)
unlocks a window based user interface element if it's in a docked state.
void reset()
resets the layout manager and remove all of its internal user interface elements.
boolean dockAllWindows([in] short nElementType)
docks all windows which are member of the provided user interface element type.
boolean floatWindow([in] string ResourceURL)
forces a window based user interface element to float.
void setVisible([in] boolean Visible)
sets the layout manager to invisible state and hides all user interface elements.
com::sun::star::ui::XUIElement getElement([in] string ResourceURL)
retrieves a user interface element which has been created before.
this interface enables developer to implement different docking area acceptors which are used by the ...
Definition XDockingAreaAcceptor.idl:42
provides a function to retrieve a special purpose interface dependent on the user interface element t...
Definition XUIElement.idl:39
base interface of all UNO interfaces
Definition generated_idl_chapter_refs.idl:452
DockingArea
specifies different docking areas a frame based layout manager supports.
Definition DockingArea.idl:38
Definition Ambiguous.idl:20
represents the environment for a desktop component
Definition generated_idl_chapter_refs.idl:874
specifies a 2-dimensional point using the Cartesian coordinate system.
Definition Point.idl:28
specifies a rectangular area by position and size.
Definition Rectangle.idl:28
specifies the 2-dimensional size of an area using width and height.
Definition Size.idl:28