xref: /aoo42x/main/offapi/com/sun/star/form/NavigationBarMode.idl (revision cdf0e10c)

/*************************************************************************
 *
 * 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_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