xref: /trunk/main/offapi/com/sun/star/awt/XTopWindow2.idl (revision cdf0e10c)
1/*************************************************************************
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 *
4 * Copyright 2000, 2010 Oracle and/or its affiliates.
5 *
6 * OpenOffice.org - a multi-platform office productivity suite
7 *
8 * This file is part of OpenOffice.org.
9 *
10 * OpenOffice.org is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Lesser General Public License version 3
12 * only, as published by the Free Software Foundation.
13 *
14 * OpenOffice.org is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU Lesser General Public License version 3 for more details
18 * (a copy is included in the LICENSE file that accompanied this code).
19 *
20 * You should have received a copy of the GNU Lesser General Public License
21 * version 3 along with OpenOffice.org.  If not, see
22 * <http://www.openoffice.org/license.html>
23 * for a copy of the LGPLv3 License.
24 *
25************************************************************************/
26
27#ifndef __com_sun_star_awt_XTopWindow2_idl__
28#define __com_sun_star_awt_XTopWindow2_idl__
29
30#include <com/sun/star/awt/XTopWindow.idl>
31#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
32
33//=============================================================================
34
35module com { module sun { module star { module awt {
36
37//=============================================================================
38
39/** extends XTopWindow with additional functionality
40 */
41interface XTopWindow2 : XTopWindow
42{
43    /** controls whether the window is currently maximized
44    */
45    [attribute] boolean IsMaximized;
46
47    /** controls whether the window is currently minimized
48    */
49    [attribute] boolean IsMinimized;
50
51    /** controls on which display the window is shown.
52
53        <p>When retrieving this property, in case the window is positioned on multiple displays,
54        the number returned will be of the display containing the upper left pixel of the frame
55        area (that is of the client area on system decorated windows, or the frame area of
56        undecorated resp. owner decorated windows).</p>
57
58        @throws ::com::sun::star::lang::IndexOutOfBoundsException
59            if you attempt to set this property to a value which does not correspond to the number
60            of an existing screen.
61
62        @see com::sun::star::awt::DisplayAccess
63        @see com::sun::star::awt::DisplayInfo
64    */
65    [attribute] long Display
66    {
67        set raises (::com::sun::star::lang::IndexOutOfBoundsException);
68    };
69};
70
71//=============================================================================
72
73}; }; }; };
74
75//=============================================================================
76
77#endif
78