/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_ui_DockingArea_idl__
#define __com_sun_star_ui_DockingArea_idl__

//============================================================================= 

module com { module sun { module star { module ui {

//============================================================================= 

/** specifies different docking areas a frame based layout manager
    supports.

    <p>
    A frame based layout manager supports four different docking areas where
    dockable user interface elements can be docked.
    
    @see com::sun::star::frame::XLayoutManager
    </p>
    
    @since OOo 2.0
*/

enum DockingArea
{
    /** the top docking area below the menu bar.
    */
    DOCKINGAREA_TOP,
    
    /** the bottom docking area above the status bar.
    */
    DOCKINGAREA_BOTTOM,
    
    /** the left side docking area.
    */
    DOCKINGAREA_LEFT,
    
    /** the right side docking area.
    */
    DOCKINGAREA_RIGHT,

    /** a default docking area. It depends on the implementation
        how to treat this value.
    */
    DOCKINGAREA_DEFAULT
};

}; }; }; };

#endif
