offapi/com/sun/star/ui/DockingArea.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_ui_DockingArea_idl__
  29 #define __com_sun_star_ui_DockingArea_idl__
  30
  31 //=============================================================================
  32
  33 module com { module sun { module star { module ui {
  34
  35 //=============================================================================
  36
  37 /** specifies different docking areas a frame based layout manager
  38     supports.
  39
  40     <p>
  41     A frame based layout manager supports four different docking areas where
  42     dockable user interface elements can be docked.
  43
  44     @see com::sun::star::frame::XLayoutManager
  45     </p>
  46
  47     @since OOo 2.0.0
  48 */
  49
  50 enum DockingArea
  51 {
  52     /** the top docking area below the menu bar.
  53     */
  54     DOCKINGAREA_TOP,
  55
  56     /** the bottom docking area above the status bar.
  57     */
  58     DOCKINGAREA_BOTTOM,
  59
  60     /** the left side docking area.
  61     */
  62     DOCKINGAREA_LEFT,
  63
  64     /** the right side docking area.
  65     */
  66     DOCKINGAREA_RIGHT,
  67
  68     /** a default docking area. It depends on the implementation
  69         how to treat this value.
  70     */
  71     DOCKINGAREA_DEFAULT
  72 };
  73
  74 }; }; }; };
  75
  76 #endif