xref: /aoo41x/main/offapi/com/sun/star/ui/DockingArea.idl (revision f431c806) 
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_ui_DockingArea_idl__
25#define __com_sun_star_ui_DockingArea_idl__
26
27//=============================================================================
28
29module com { module sun { module star { module ui {
30
31//=============================================================================
32
33/** specifies different docking areas a frame based layout manager
34    supports.
35
36    <p>
37    A frame based layout manager supports four different docking areas where
38    dockable user interface elements can be docked.
39
40    @see com::sun::star::frame::XLayoutManager
41    </p>
42
43    @since OpenOffice 2.0
44*/
45
46published enum DockingArea
47{
48    /** the top docking area below the menu bar.
49    */
50    DOCKINGAREA_TOP,
51
52    /** the bottom docking area above the status bar.
53    */
54    DOCKINGAREA_BOTTOM,
55
56    /** the left side docking area.
57    */
58    DOCKINGAREA_LEFT,
59
60    /** the right side docking area.
61    */
62    DOCKINGAREA_RIGHT,
63
64    /** a default docking area. It depends on the implementation
65        how to treat this value.
66    */
67    DOCKINGAREA_DEFAULT
68};
69
70}; }; }; };
71
72#endif
73