offapi/com/sun/star/frame/LayoutManager.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: LayoutManager.idl,v $
  10  * $Revision: 1.7 $
  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_frame_LayoutManager_idl__
  32 #define __com_sun_star_frame_LayoutManager_idl__
  33
  34 #ifndef __com_sun_star_frame_XLayoutManager_idl__
  35 #include <com/sun/star/frame/XLayoutManager.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_frame_XFrameActionListener_idl__
  39 #include <com/sun/star/frame/XFrameActionListener.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_ui_XUIConfigurationListener_idl__
  43 #include <com/sun/star/ui/XUIConfigurationListener.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_frame_XInplaceLayout_idl__
  47 #include <com/sun/star/frame/XInplaceLayout.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_beans_XPropertySet_idl__
  51 #include <com/sun/star/beans/XPropertySet.idl>
  52 #endif
  53
  54 #ifndef __com_sun_star_frame_XMenuBarMergingAcceptor_idl__
  55 #include <com/sun/star/frame/XMenuBarMergingAcceptor.idl>
  56 #endif
  57
  58 #ifndef __com_sun_star_frame_XLayoutManagerEventBroadcaster_idl__
  59 #include <com/sun/star/frame/XLayoutManagerEventBroadcaster.idl>
  60 #endif
  61
  62 //=============================================================================
  63
  64  module com { module sun { module star { module frame {
  65
  66 //=============================================================================
  67 /** controls the layout of user interface elements which are part of a frame.
  68
  69     <p>
  70     Layout management is the process of determining the size and position of
  71     user interface elements. By default, each <type>Frame</type> has a layout
  72     manager -- it performs layout management for the user interface elements
  73     within the frame. User interface elements can provide size and alignment
  74     hints to layout managers, but layout managers have the final decision on
  75     the size and position of those user interface elements.
  76     </p>
  77
  78     @since OOo 2.0.0
  79 */
  80
  81 service LayoutManager
  82 {
  83     /** central interface to query for, create, destroy and manipulate user
  84         interface elements which are bound to a frame.
  85
  86         @see ::com::sun::star::frame::XLayoutManager;
  87     */
  88     interface ::com::sun::star::frame::XLayoutManager;
  89
  90     /** notification interface to receive status information about the state
  91         of the connected frame.
  92
  93         <p>
  94         E.g., you can receive events of instantiation/destruction and
  95         activation/deactivation of a frame.
  96         </p>
  97
  98         @see XFrame::addFrameActionListener()
  99         @see XFrame::removeFrameActionListener()
 100     */
 101     interface ::com::sun::star::frame::XFrameActionListener;
 102
 103     /** notification interface to receive change messages of user interface
 104         elements which are part of the layout manager.
 105
 106         <p>
 107         E.g., you can receive events of insertion/replacing and
 108         removing of settings data of user interface elements.
 109         </p>
 110
 111         @see com::sun::star::ui::XUIConfiguration
 112     */
 113     interface ::com::sun::star::ui::XUIConfigurationListener;
 114
 115     /** provides functions to merge menus for inplace editing of components
 116         inside OpenOffice.org.
 117     */
 118     interface ::com::sun::star::frame::XMenuBarMergingAcceptor;
 119
 120     /** registers listeners that want to receive layout manager
 121         events.
 122     */
 123     [optional] interface ::com::sun::star::frame::XLayoutManagerEventBroadcaster;
 124
 125     /** interface to support settings a menu bar for inplace editing of
 126         components inside OpenOffice.org.
 127
 128         @deprecated
 129     */
 130     [optional] interface ::com::sun::star::frame::XInplaceLayout;
 131 };
 132
 133 }; }; }; };
 134
 135 #endif