offapi/com/sun/star/awt/XTopWindow2.idl

   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 #ifndef __com_sun_star_awt_XTopWindow2_idl__
  21 #define __com_sun_star_awt_XTopWindow2_idl__
  22
  23 #include <com/sun/star/awt/XTopWindow.idl>
  24 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  25
  26
  27 module com { module sun { module star { module awt {
  28
  29
  30 /** extends XTopWindow with additional functionality
  31  */
  32 interface XTopWindow2 : XTopWindow
  33 {
  34     /** controls whether the window is currently maximized
  35     */
  36     [attribute] boolean IsMaximized;
  37
  38     /** controls whether the window is currently minimized
  39     */
  40     [attribute] boolean IsMinimized;
  41
  42     /** controls on which display the window is shown.
  43
  44         <p>When retrieving this property, in case the window is positioned on multiple displays,
  45         the number returned will be of the display containing the upper left pixel of the frame
  46         area (that is of the client area on system decorated windows, or the frame area of
  47         undecorated resp. owner decorated windows).</p>
  48
  49         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  50             if you attempt to set this property to a value which does not correspond to the number
  51             of an existing screen.
  52
  53         @see com::sun::star::awt::DisplayAccess
  54         @see com::sun::star::awt::DisplayInfo
  55     */
  56     [attribute] long Display
  57     {
  58         set raises (::com::sun::star::lang::IndexOutOfBoundsException);
  59     };
  60 };
  61
  62
  63 }; }; }; };
  64
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */