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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: WindowStateConfiguration.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_ui_WindowStateConfiguration_idl__
  32 #define __com_sun_star_ui_WindowStateConfiguration_idl__
  33
  34 #ifndef __com_sun_star_container_XNameAccess_idl__
  35 #include <com/sun/star/container/XNameAccess.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module ui {
  41
  42 //=============================================================================
  43
  44 /** a service which provides window based information about user interface
  45     elements.
  46
  47     <p>
  48     OpenOffice.org has an amout of user interface elements that can be positioned,
  49     resized, closed and their style can be changed. This service provides access
  50     to the window based information of available user interface elements which are
  51     part of OpenOffice.org modules, like Writer or Calc.
  52     </p>
  53
  54     @since OOo 2.0.0
  55 */
  56
  57 service WindowStateConfiguration
  58 {
  59     /** provides access to window based information about user interface elements
  60         of all installed application modules.
  61
  62         <p>
  63         To access the window based information of a module, a unique module specifier
  64         must be provided to <member scope="com::sun::star::container">XNameAccess::getByName()</member> function.
  65         The module specifier can be retrieved from the <type scope="com::sun::star::frame">ModuleManager</type>
  66         service. The interface provides references to a <type scope="com::sun:star::ui">ModuleWindowStateConfiguration</type>.
  67         </p>
  68
  69         @see com::sun::star::frame::ModuleManager
  70     */
  71
  72     interface com::sun::star::container::XNameAccess;
  73 };
  74
  75 }; }; }; };
  76
  77 #endif