LibreOffice
LibreOffice 7.2 SDK API Reference
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 #ifndef __com_sun_star_frame_XLayoutManager_idl__
21 #define __com_sun_star_frame_XLayoutManager_idl__
22 
31 
32 
33 module com { module sun { module star { module frame {
34 
35 
69 {
81 
94  void reset();
95 
109 
122 
137 
145  void createElement( [in] string ResourceURL );
146 
154  void destroyElement( [in] string ResourceURL );
155 
175  boolean requestElement( [in] string ResourceURL );
176 
189  com::sun::star::ui::XUIElement getElement( [in] string ResourceURL );
190 
202  sequence< com::sun::star::ui::XUIElement > getElements();
203 
214  boolean showElement( [in] string ResourceURL );
215 
226  boolean hideElement( [in] string ResourceURL );
227 
246  boolean dockWindow( [in] string ResourceURL, [in] com::sun::star::ui::DockingArea DockingArea, [in] com::sun::star::awt::Point Pos );
247 
259  boolean dockAllWindows( [in] short nElementType );
260 
271  boolean floatWindow( [in] string ResourceURL );
272 
283  boolean lockWindow( [in] string ResourceURL );
284 
296  boolean unlockWindow( [in] string ResourceURL );
297 
313  void setElementSize( [in] string ResourceURL, [in] com::sun::star::awt::Size Size );
314 
330  void setElementPos( [in] string ResourceURL, [in] com::sun::star::awt::Point Pos );
331 
350  void setElementPosSize( [in] string ResourceURL, [in] com::sun::star::awt::Point Pos, [in] com::sun::star::awt::Size Size );
351 
362  boolean isElementVisible( [in] string ResourceURL );
363 
374  boolean isElementFloating( [in] string ResourceURL );
375 
386  boolean isElementDocked( [in] string ResourceURL );
387 
398  boolean isElementLocked( [in] string ResourceURL );
399 
410  com::sun::star::awt::Size getElementSize( [in] string ResourceURL );
411 
422  com::sun::star::awt::Point getElementPos( [in] string ResourceURL );
423 
431  void lock();
432 
440  void unlock();
441 
444  void doLayout();
445 
459  void setVisible( [in] boolean Visible );
460 
471  boolean isVisible();
472 
473 };
474 
475 }; }; }; };
476 
477 #endif
478 
479 /* 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: XFrame.idl:44
central interface to query for, create, destroy and manipulate user interface elements which are boun...
Definition: XLayoutManager.idl:69
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:49
provides a function to retrieve a special purpose interface dependent on the user interface element t...
Definition: XUIElement.idl:46
base interface of all UNO interfaces
Definition: XInterface.idl:48
DockingArea
specifies different docking areas a frame based layout manager supports.
Definition: DockingArea.idl:41
Definition: Ambiguous.idl:22
represents the environment for a desktop component
Definition: Frame.idl:41
specifies a 2-dimensional point using the Cartesian coordinate system.
Definition: Point.idl:30
specifies a rectangular area by position and size.
Definition: Rectangle.idl:30
specifies the 2-dimensional size of an area using width and height.
Definition: Size.idl:30