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