offapi/com/sun/star/frame/LayoutManagerEvents.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: LayoutManagerEvents.idl,v $
  10  * $Revision: 1.8 $
  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 #ifndef __com_sun_star_frame_LayoutManagerEvents_idl__
  31 #define __com_sun_star_frame_LayoutManagerEvents_idl__
  32
  33 //=============================================================================
  34
  35 module com {  module sun {  module star {  module frame {
  36
  37 //=============================================================================
  38 /** provides information about layout manager events
  39
  40     <p>Events are provided <strong>only</strong> for notification
  41     purposes only.</p>
  42
  43     @see com::sun::star::frame::LayoutManager
  44     @see com::sun::star::frame::XLayoutManagerEventBroadcaster
  45
  46     @since OOo 2.0.0
  47  */
  48 constants LayoutManagerEvents
  49 {
  50     //-------------------------------------------------------------------------
  51     /** specifies that the layout manager processed a lock call, which
  52         prevents it from doing layouts.
  53
  54         <p>
  55         This event sends the current lock count as additional
  56         information.
  57         </p>
  58      */
  59     const short LOCK = 0;
  60
  61     //-------------------------------------------------------------------------
  62     /** specifies that the layout manager processed an unlock call, which
  63         admit layouts when the lock count is zero.
  64
  65         <p>
  66         This event sends the current lock count as additional
  67         information.
  68         </p>
  69      */
  70     const short UNLOCK = 1;
  71
  72     //-------------------------------------------------------------------------
  73     /** specifies that the layout manager refreshed the layout of
  74         the frame.
  75
  76         <p>
  77         This event sends no additional information.
  78         </p>
  79      */
  80     const short LAYOUT = 2;
  81
  82     //-------------------------------------------------------------------------
  83     /** specifies that the layout manager container frame window
  84         becomes visible.
  85
  86         <p>
  87         This event sends no additional information.
  88         </p>
  89      */
  90     const short VISIBLE = 3;
  91
  92     //-------------------------------------------------------------------------
  93     /** specifies that the layout manager container frame window
  94         becomes invisible.
  95
  96         <p>
  97         This event sends no additional information.
  98         </p>
  99      */
 100     const short INVISIBLE = 4;
 101
 102     //-------------------------------------------------------------------------
 103     /** A merged menu bar has been set at the layout manager.
 104
 105         <p>
 106         This event sends no additional information.
 107         </p>
 108      */
 109     const short MERGEDMENUBAR = 5;
 110
 111     //-------------------------------------------------------------------------
 112     /** specifies that a certain user interface element has been made
 113         visible
 114
 115         <p>
 116         This event sends the resource url of the newly visible user
 117         interface element.
 118         </p>
 119      */
 120     const short UIELEMENT_VISIBLE = 6;
 121
 122     //-------------------------------------------------------------------------
 123     /** specifies that a certain user interface element has been made
 124         invisible
 125
 126         <p>
 127         This event sends the resource url of the invisible user
 128         interface element.
 129         </p>
 130      */
 131     const short UIELEMENT_INVISIBLE = 7;
 132 };
 133
 134 }; }; }; };
 135
 136 #endif