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