xref: /aoo42x/main/offapi/com/sun/star/awt/XTimeField.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_awt_XTimeField_idl__
#define __com_sun_star_awt_XTimeField_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif


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

 module com {  module sun {  module star {  module awt {

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

/** gives access to the value and settings of a time field.
 */
published interface XTimeField: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** sets the time value which is displayed in the time field.

        <p>The time value must be specified in the format HHMMSShh,
        where HH are hours, MM are minutes, SS are seconds and hh are
        hundredth seconds.</p>
	 */
	[oneway] void setTime( [in] long Time );

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

	/** returns the time value which is currently displayed in the time field.
	 */
	long getTime();

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

	/** sets the minimum time value that can be entered by the user.
	 */
	[oneway] void setMin( [in] long Time );

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

	/** returns the currently set minimum time value that can be entered by
        the user.
	 */
	long getMin();

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

	/** sets the maximum time value that can be entered by the user.
	 */
	[oneway] void setMax( [in] long Time );

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

	/** returns the currently set maximum time value that can be entered by
        the user.
     */
	long getMax();

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

	/** sets the first value to be set on POS1 key.
	 */
	[oneway] void setFirst( [in] long Time );

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

	/** returns the currently set first value which is set on POS1 key.
	 */
	long getFirst();

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

	/** sets the last value to be set on END key.
	 */
	[oneway] void setLast( [in] long Time );

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

	/** returns the currently set last value which is set on END key.
	 */
	long getLast();

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

	/** sets an empty value for the time.
	 */
	void setEmpty();

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

	/** returns whether currently an empty value is set for the time.
	 */
	boolean isEmpty();

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

	/** determines if the format is checked during user input.
	 */
	[oneway] void setStrictFormat( [in] boolean bStrict );

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

	/** returns whether the format is currently checked during user input.
	 */
	boolean isStrictFormat();

};

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

}; }; }; };

#endif