offapi/com/sun/star/ui/ModuleWindowStateConfiguration.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef __com_sun_star_ui_ModuleUICommandDescription_idl__
  30 #define __com_sun_star_ui_ModuleUICommandDescription_idl__
  31
  32 #include <com/sun/star/container/XNameContainer.idl>
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module ui {
  37
  38 //=============================================================================
  39
  40 /** a service which provides window based information about user interface
  41     elements of a single application module.
  42
  43     <p>
  44     Every OpenOffice.org module has an amount of user interface elements that can
  45     be positioned, resized, closed and their style can be changed. This service
  46     provides access to the window based information of available user interface
  47     elements which are part of a single OpenOffice.org module, like Writer or
  48     Calc.
  49     </p>
  50
  51     @since OOo 2.0
  52 */
  53
  54 service ModuleWindowStateConfiguration
  55 {
  56     /** provides read/write access to window based information of user interface
  57         elements which are part of single installed module.
  58
  59         <p>
  60         An implementation must provide a <type scope="com::sun::star::uno">Sequence</type> which
  61         has <type scope="com::sun::star::beans">PropertyValue</type> as entries. The following
  62         entries a defined:
  63         <ul>
  64             <li><b>Docked</b><br>a boolean which specifies if the window is docked or not.</li>
  65             <li><b>DockingArea</b><br>a <type scope="com::sun::star::ui">DockingArea</type>
  66             which specifies the docking area where the window is docked.</li>
  67             <li><b>DockPos</b><br>a <type scope="com::sun::star::awt">Point</type> which specifies the
  68             docked position of a window. The X and Y values are interpreted as a row/column number and
  69             a pixel position for top/bottom docked windows. For left/right docked windows this is</li>
  70             <li><b>DockSize</b><br>a <type scope="com::sun::star::awt">Size</type> which specifies
  71             the docked size of the window. This property is currently not used by the layout manager
  72             implementation. For future use.</li>
  73             <li><b>Locked</b><br>a boolean which specifies if the window is locked or not. This property
  74             is only valid for docked windows</li>
  75             <li><b>Pos</b><br>a <type scope="com::sun::star::awt">Point</type> which specifies the
  76             floating position in pixel of the window.</li>
  77             <li><b>Size</b><br>a <type scope="com::sun::star::awt">Size</type> which specifies the
  78             floating size in pixel of the window.</li>
  79             <li><b>Style</b><br>a long which specifies the style of the window. A toolbar support the
  80             following values: 0 = icons, 1 = text, 2 = text+icons.</li>
  81             <li><b>UIName</br><br>a localized string which specifies the default window title.</li>
  82         </ul>
  83         The key to a user interface element is the resource URL which has
  84         the following syntax "private:resource/$type/$name". For example "private:resource/toolbar/standardbar"
  85         addresses the standard bar of a module.
  86         A complete list of all user interface elements is available in the Developers Guide.
  87         </p>
  88
  89         @see com::sun::star::frame::ModuleManager
  90     */
  91
  92     interface com::sun::star::container::XNameContainer;
  93 };
  94
  95 }; }; }; };
  96
  97 #endif
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */