offapi/com/sun/star/ui/DockingArea.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
  21 module com { module sun { module star { module ui {
  22
  23
  24 /** specifies different docking areas a frame based layout manager
  25     supports.
  26
  27     <p>
  28     A frame based layout manager supports four different docking areas where
  29     dockable user interface elements can be docked.
  30
  31     @see com::sun::star::frame::XLayoutManager
  32     </p>
  33
  34     @since OOo 2.0
  35 */
  36
  37 enum DockingArea
  38 {
  39     /** the top docking area below the menu bar.
  40     */
  41     DOCKINGAREA_TOP,
  42
  43     /** the bottom docking area above the status bar.
  44     */
  45     DOCKINGAREA_BOTTOM,
  46
  47     /** the left side docking area.
  48     */
  49     DOCKINGAREA_LEFT,
  50
  51     /** the right side docking area.
  52     */
  53     DOCKINGAREA_RIGHT,
  54
  55     /** a default docking area. It depends on the implementation
  56         how to treat this value.
  57     */
  58     DOCKINGAREA_DEFAULT
  59 };
  60
  61 }; }; }; };
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */