offapi/com/sun/star/ui/DockingArea.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: DockingArea.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_DockingArea_idl__
  32 #define __com_sun_star_ui_DockingArea_idl__
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module ui {
  37
  38 //=============================================================================
  39
  40 /** specifies different docking areas a frame based layout manager
  41     supports.
  42
  43     <p>
  44     A frame based layout manager supports four different docking areas where
  45     dockable user interface elements can be docked.
  46
  47     @see com::sun::star::frame::XLayoutManager
  48     </p>
  49
  50     @since OOo 2.0.0
  51 */
  52
  53 enum DockingArea
  54 {
  55     /** the top docking area below the menu bar.
  56     */
  57     DOCKINGAREA_TOP,
  58
  59     /** the bottom docking area above the status bar.
  60     */
  61     DOCKINGAREA_BOTTOM,
  62
  63     /** the left side docking area.
  64     */
  65     DOCKINGAREA_LEFT,
  66
  67     /** the right side docking area.
  68     */
  69     DOCKINGAREA_RIGHT,
  70
  71     /** a default docking area. It depends on the implementation
  72         how to treat this value.
  73     */
  74     DOCKINGAREA_DEFAULT
  75 };
  76
  77 }; }; }; };
  78
  79 #endif