xref: /aoo41x/main/offapi/com/sun/star/awt/XTopWindow2.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_awt_XTopWindow2_idl__
25#define __com_sun_star_awt_XTopWindow2_idl__
26
27#include <com/sun/star/awt/XTopWindow.idl>
28#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
29
30//=============================================================================
31
32module com { module sun { module star { module awt {
33
34//=============================================================================
35
36/** extends XTopWindow with additional functionality
37 */
38interface XTopWindow2 : XTopWindow
39{
40    /** controls whether the window is currently maximized
41    */
42    [attribute] boolean IsMaximized;
43
44    /** controls whether the window is currently minimized
45    */
46    [attribute] boolean IsMinimized;
47
48    /** controls on which display the window is shown.
49
50        <p>When retrieving this property, in case the window is positioned on multiple displays,
51        the number returned will be of the display containing the upper left pixel of the frame
52        area (that is of the client area on system decorated windows, or the frame area of
53        undecorated resp. owner decorated windows).</p>
54
55        @throws ::com::sun::star::lang::IndexOutOfBoundsException
56            if you attempt to set this property to a value which does not correspond to the number
57            of an existing screen.
58
59        @see com::sun::star::awt::DisplayAccess
60        @see com::sun::star::awt::DisplayInfo
61    */
62    [attribute] long Display
63    {
64        set raises (::com::sun::star::lang::IndexOutOfBoundsException);
65    };
66};
67
68//=============================================================================
69
70}; }; }; };
71
72//=============================================================================
73
74#endif
75