offapi/com/sun/star/frame/LayoutManager.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 #ifndef __com_sun_star_frame_LayoutManager_idl__
  21 #define __com_sun_star_frame_LayoutManager_idl__
  22
  23 #include <com/sun/star/frame/XLayoutManager.idl>
  24 #include <com/sun/star/frame/XFrameActionListener.idl>
  25 #include <com/sun/star/ui/XUIConfigurationListener.idl>
  26 #include <com/sun/star/beans/XPropertySet.idl>
  27 #include <com/sun/star/frame/XMenuBarMergingAcceptor.idl>
  28 #include <com/sun/star/frame/XLayoutManagerEventBroadcaster.idl>
  29
  30
  31  module com { module sun { module star { module frame {
  32
  33 /** controls the layout of user interface elements which are part of a frame.
  34
  35     <p>
  36     Layout management is the process of determining the size and position of
  37     user interface elements. By default, each <type>Frame</type> has a layout
  38     manager -- it performs layout management for the user interface elements
  39     within the frame. User interface elements can provide size and alignment
  40     hints to layout managers, but layout managers have the final decision on
  41     the size and position of those user interface elements.
  42     </p>
  43
  44     @since OOo 2.0
  45 */
  46
  47 service LayoutManager
  48 {
  49     /** central interface to query for, create, destroy and manipulate user
  50         interface elements which are bound to a frame.
  51
  52         @see ::com::sun::star::frame::XLayoutManager;
  53     */
  54     interface ::com::sun::star::frame::XLayoutManager;
  55
  56     /** notification interface to receive status information about the state
  57         of the connected frame.
  58
  59         <p>
  60         E.g., you can receive events of instantiation/destruction and
  61         activation/deactivation of a frame.
  62         </p>
  63
  64         @see XFrame::addFrameActionListener()
  65         @see XFrame::removeFrameActionListener()
  66     */
  67     interface ::com::sun::star::frame::XFrameActionListener;
  68
  69     /** notification interface to receive change messages of user interface
  70         elements which are part of the layout manager.
  71
  72         <p>
  73         E.g., you can receive events of insertion/replacing and
  74         removing of settings data of user interface elements.
  75         </p>
  76
  77         @see com::sun::star::ui::XUIConfiguration
  78     */
  79     interface ::com::sun::star::ui::XUIConfigurationListener;
  80
  81     /** provides functions to merge menus for inplace editing of components
  82         inside OpenOffice.org.
  83     */
  84     interface ::com::sun::star::frame::XMenuBarMergingAcceptor;
  85
  86     /** registers listeners that want to receive layout manager
  87         events.
  88     */
  89     [optional] interface ::com::sun::star::frame::XLayoutManagerEventBroadcaster;
  90
  91 };
  92
  93 }; }; }; };
  94
  95 #endif
  96
  97 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */