/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: NavigationBarMode.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 00:21:32 $
 *
 *  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_form_NavigationBarMode_idl__
#define __com_sun_star_form_NavigationBarMode_idl__


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

 module com {  module sun {  module star {  module form {

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

/** describes in which way the navigation of the records of a database form is performed.
 */
published enum NavigationBarMode
{
    //-------------------------------------------------------------------------

    /** no navigation bar is provided and navigation on the current
        form is only possible with the keyboard (TAB/SHIFT TAB).

        <p>Note that when this mode is set, a simultaneous <type>TabulatorCycle</type>
        value of <member>TabulatorCycle::CURRENT</member> means that you cannot travel
        between records anymore.</p>

        @see TabulatorCycle
     */
    NONE,

    //-------------------------------------------------------------------------

    /** a navigation bar is provided and navigation will be performed
        on the current/active form.
        <p>This is the default and most often encountered mode.</p>
     */
    CURRENT,

    //-------------------------------------------------------------------------

    /** a navigation bar is provided and navigation will be performed
        on the parent of the current/active form.

        <p>This options is usually used for forms containing an grid control only.
        In such a form, the control has it's own navigation elements, so there is
        no need to use the navigation bar for the form, but rather for it's parent.
        </p>
     */
    PARENT

};

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

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif
