/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: DockingArea.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 08:20:00 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#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.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
