offapi/com/sun/star/ui/ModuleWindowStateConfiguration.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 ui {
  22
  23
  24 /** a service which provides window based information about user interface
  25     elements of a single application module.
  26
  27     <p>
  28     Every OpenOffice.org module has an amount of user interface elements that can
  29     be positioned, resized, closed and their style can be changed. This service
  30     provides access to the window based information of available user interface
  31     elements which are part of a single OpenOffice.org module, like Writer or
  32     Calc.
  33     </p>
  34
  35     @since OOo 2.0
  36 */
  37
  38 service ModuleWindowStateConfiguration
  39 {
  40     /** provides read/write access to window based information of user interface
  41         elements which are part of single installed module.
  42
  43         <p>
  44         An implementation must provide a com::sun::star::uno::Sequence which
  45         has com::sun::star::beans::PropertyValue as entries. The following
  46         entries a defined:
  47         <ul>
  48             <li><b>Docked</b><br>a boolean which specifies if the window is docked or not.</li>
  49             <li><b>DockingArea</b><br>a com::sun::star::ui::DockingArea
  50             which specifies the docking area where the window is docked.</li>
  51             <li><b>DockPos</b><br>a com::sun::star::awt::Point which specifies the
  52             docked position of a window. The X and Y values are interpreted as a row/column number and
  53             a pixel position for top/bottom docked windows. For left/right docked windows this is</li>
  54             <li><b>DockSize</b><br>a com::sun::star::awt::Size which specifies
  55             the docked size of the window. This property is currently not used by the layout manager
  56             implementation. For future use.</li>
  57             <li><b>Locked</b><br>a boolean which specifies if the window is locked or not. This property
  58             is only valid for docked windows</li>
  59             <li><b>Pos</b><br>a com::sun::star::awt::Point which specifies the
  60             floating position in pixel of the window.</li>
  61             <li><b>Size</b><br>a com::sun::star::awt::Size which specifies the
  62             floating size in pixel of the window.</li>
  63             <li><b>Style</b><br>a long which specifies the style of the window. A toolbar support the
  64             following values: 0 = icons, 1 = text, 2 = text+icons.</li>
  65             <li><b>UIName</b><br>a localized string which specifies the default window title.</li>
  66         </ul>
  67         The key to a user interface element is the resource URL which has
  68         the following syntax "private:resource/$type/$name". For example "private:resource/toolbar/standardbar"
  69         addresses the standard bar of a module.
  70         A complete list of all user interface elements is available in the Developers Guide.
  71         </p>
  72
  73         @see com::sun::star::frame::ModuleManager
  74     */
  75
  76     interface com::sun::star::container::XNameContainer;
  77 };
  78
  79 }; }; }; };
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */