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