LibreOffice LibreOffice 24.2 SDK API Reference

Loading...
Searching...
No Matches
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
20
21module com { module sun { module star { module awt {
22
23
31 interface XDockableWindow : com::sun::star::uno::XInterface
32{
33
37 void addDockableWindowListener( [in] com::sun::star::awt::XDockableWindowListener xListener );
38
39
42 void removeDockableWindowListener( [in] com::sun::star::awt::XDockableWindowListener xListener );
43
44
52 void enableDocking( [in] boolean bEnable );
53
54
60 boolean isFloating();
61
62
68 void setFloatingMode( [in] boolean bFloating );
69
70
74 void lock();
75
76
80 void unlock();
81
82
88 boolean isLocked();
89
90
100 void startPopupMode( [in] com::sun::star::awt::Rectangle WindowRect );
101
102
110 boolean isInPopupMode();
111};
112
113
114}; }; }; };
115
116/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::awt::XDockableWindowListener
makes it possible to receive docking events.
Definition XDockableWindowListener.idl:27
com::sun::star::awt::XDockableWindow
specifies the docking interface for a window component.
Definition XDockableWindow.idl:32
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:46
com
Definition Ambiguous.idl:20
com::sun::star::awt::Rectangle
specifies a rectangular area by position and size.
Definition Rectangle.idl:28