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