LibreOffice: com/sun/star/awt/XDockableWindow.idl Source File

LibreOffice LibreOffice 7.3 SDK API Reference

XDockableWindow.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_awt_XDockableWindow_idl__
20#define __com_sun_star_awt_XDockableWindow_idl__
21
22#include <com/sun/star/uno/XInterface.idl>
23#include <com/sun/star/awt/XDockableWindowListener.idl>
24#include <com/sun/star/awt/Rectangle.idl>
25
26
27module com { module sun { module star { module awt {
28
29
37 interface XDockableWindow : com::sun::star::uno::XInterface
38{
39
43 void addDockableWindowListener( [in] com::sun::star::awt::XDockableWindowListener xListener );
44
45
48 void removeDockableWindowListener( [in] com::sun::star::awt::XDockableWindowListener xListener );
49
50
58 void enableDocking( [in] boolean bEnable );
59
60
66 boolean isFloating();
67
68
74 void setFloatingMode( [in] boolean bFloating );
75
76
80 void lock();
81
82
86 void unlock();
87
88
94 boolean isLocked();
95
96
106 void startPopupMode( [in] com::sun::star::awt::Rectangle WindowRect );
107
108
116 boolean isInPopupMode();
117};
118
119
120}; }; }; };
121
122#endif
123
124/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Rectangle.idl
XDockableWindowListener.idl
XInterface.idl
com::sun::star::awt::XDockableWindowListener
makes it possible to receive docking events.
Definition: XDockableWindowListener.idl:36
com::sun::star::awt::XDockableWindow
specifies the docking interface for a window component.
Definition: XDockableWindow.idl:38
com::sun::star::awt::XDockableWindow::setFloatingMode
void setFloatingMode([in] boolean bFloating)
toggle between floating and docked state
com::sun::star::awt::XDockableWindow::addDockableWindowListener
void addDockableWindowListener([in] com::sun::star::awt::XDockableWindowListener xListener)
adds a docking listener to the object.
com::sun::star::awt::XDockableWindow::enableDocking
void enableDocking([in] boolean bEnable)
enable or disable docking, docking is disabled by default
com::sun::star::awt::XDockableWindow::removeDockableWindowListener
void removeDockableWindowListener([in] com::sun::star::awt::XDockableWindowListener xListener)
removes the specified docking listener from the object.
com::sun::star::awt::XDockableWindow::startPopupMode
void startPopupMode([in] com::sun::star::awt::Rectangle WindowRect)
shows the window in a menu like style, i.e.
com::sun::star::awt::XDockableWindow::unlock
void unlock()
enables undocking this has no effect if the window is floating
com::sun::star::awt::XDockableWindow::lock
void lock()
prevents the window from being undocked this has no effect if the window is floating
com::sun::star::awt::XDockableWindow::isLocked
boolean isLocked()
queries the current locking state
com::sun::star::awt::XDockableWindow::isFloating
boolean isFloating()
queries the current window state
com::sun::star::awt::XDockableWindow::isInPopupMode
boolean isInPopupMode()
queries the current pop-up mode
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com
Definition: Accessible.idl:22
com::sun::star::awt::Rectangle
specifies a rectangular area by position and size.
Definition: Rectangle.idl:30