offapi/com/sun/star/ui/theWindowStateConfiguration.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 singleton which provides window based information about user interface
  25     elements.
  26
  27     <p>
  28     OpenOffice.org has an amount of user interface elements that can be positioned,
  29     resized, closed and their style can be changed. This singleton provides access
  30     to the window based information of available user interface elements which are
  31     part of OpenOffice.org modules, like Writer or Calc.
  32     </p>
  33
  34     Provides access to window based information about user interface elements
  35     of all installed application modules.
  36
  37     <p>
  38     To access the window based information of a module, a unique module specifier
  39     must be provided to com::sun::star::container::XNameAccess::getByName() function.
  40     The module specifier can be retrieved from the com::sun::star::frame::ModuleManager
  41     service. The interface provides references to a com::sun:star::ui::ModuleWindowStateConfiguration.
  42     </p>
  43
  44     Prior to LibreOffice 4.3, this singleton was only available as a
  45     (single-instance) WindowStateConfiguration service.
  46
  47     @see com::sun::star::frame::ModuleManager
  48
  49     @since LibreOffice 4.3
  50 */
  51
  52 singleton theWindowStateConfiguration : com::sun::star::container::XNameAccess;
  53
  54 }; }; }; };
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */