/*************************************************************************
 *
 *  $RCSfile: UnoControlFormattedFieldModel.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: vg $ $Date: 2003/06/27 08:56:02 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 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
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_UnoControlFormattedFieldModel_idl__
#define __com_sun_star_awt_UnoControlFormattedFieldModel_idl__

#ifndef __com_sun_star_awt_UnoControlModel_idl__
#include <com/sun/star/awt/UnoControlModel.idl>
#endif

#ifndef __com_sun_star_awt_FontDescriptor_idl__
#include <com/sun/star/awt/FontDescriptor.idl>
#endif

#ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__
#include <com/sun/star/util/XNumberFormatsSupplier.idl>
#endif


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

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

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

/** specifies the standard model of an <type>UnoControlFormattedField </type>.
 */
service UnoControlFormattedFieldModel
{
	service com::sun::star::awt::UnoControlModel;

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

	/** specifies the alignment of the text in the control. 
				
		<pre>
		0: left
		1: center
		2: right
		</pre>
	 */
	[property] short Align; 
 
	//------------------------------------------------------------------------- 

	/** specifies the background color (RGB) of the control.
	 */
	[property] long BackgroundColor; 
 
	//------------------------------------------------------------------------- 

	/** specifies the border style of the control. 
				
		<pre>
		0: No border
		1: 3D border
		2: simple border
		</pre>
	 */
	[property] short Border; 
 
	//-------------------------------------------------------------------------
    
	/** specifies the default value of the formatted field.
        
		<p>This may be a numeric value (double) or a string, depending on
        the formatting of the field.</p>
	 */
	[property] any EffectiveDefault;
    
	//-------------------------------------------------------------------------

	/** specifies the maximum value that can be entered.
        
		<p>This property is ignored if the format of the field is no numeric
        format.</p>
	 */
	[property] double EffectiveMax;
    
	//-------------------------------------------------------------------------

	/** specifies the minimum value that can be entered.
        
		<p>This property is ignored if the format of the field is no numeric
        format.</p>
	 */
	[property] double EffectiveMin;
    
	//-------------------------------------------------------------------------

	/** specifies the current value of the formatted field.
        
		<p>This may be a numeric value (double) or a string, depending on
        the formatting of the field.</p>
	 */
	[property] double EffectiveValue;
    
	//-------------------------------------------------------------------------

	/** determines whether the control is enabled or disabled.
	 */
	[property] boolean Enabled; 
 
	//------------------------------------------------------------------------- 

	/** specifies the font attributes of the text in the control.
	 */
	[property] com::sun::star::awt::FontDescriptor FontDescriptor; 
 
	//-------------------------------------------------------------------------

	/** specifies the <type scope="com::sun::star::text">FontEmphasis</type>
        value of the text in the control.
	 */
	[property] short FontEmphasisMark;
 
	//-------------------------------------------------------------------------
    
	/** specifies the <type scope="com::sun::star::text">FontRelief</type>
        value of the text in the control.
	 */
	[property] short FontRelief;
 
	//-------------------------------------------------------------------------
    
	/** specifies the format to be used when formatting the field input
        and output.
        
		<p>This value is meaningful relative to the FormatsSupplier property
        only.</p>
	 */
	[property] long FormatKey;

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

	/** supplies the formats the field should work with.
	 */
	[property] com::sun::star::util::XNumberFormatsSupplier FormatsSupplier;

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

	/** specifies the help text of the control.
	 */
	[property] string HelpText;
 
	//------------------------------------------------------------------------- 
	 
	/** specifies the help URL of the control.
	 */
	[property] string HelpURL;
    
	//-------------------------------------------------------------------------
    
	/** specifies the maximum character count.

        <p>There's no limitation, if set to 0.</p>    
     */
	[property] short MaxTextLen; 
 
	//-------------------------------------------------------------------------
    
	/** specifies that the control will be printed with the document.
	 */
	[property] boolean Printable; 
 
	//------------------------------------------------------------------------- 
	 
	/** specifies that the content of the control cannot be modified by the
        user.
	 */
	[property] boolean ReadOnly; 
 
	//-------------------------------------------------------------------------
    
	/** specifies that the control has a spin button.
	 */
	[property] boolean Spin; 
 
	//-------------------------------------------------------------------------
    
	/** specifies that the text is checked during the user input.
        
		<p>This property is optional - not every component implementing this
        service is required to provide it, as real-time input checking on a
        formatted field may be pretty expensive.</p>    
	 */
	[optional, property] boolean StrictFormat; 
 
	//------------------------------------------------------------------------- 

	/** specifies that the control can be reached with the TAB key.
	 */
	[property] boolean Tabstop; 
 
	//------------------------------------------------------------------------- 

	/** specifies the text displayed in the control.
	 */
	[property] string Text; 
 
	//------------------------------------------------------------------------- 
    
	/** specifies the text color (RGB) of the control.
	 */
	[property] long TextColor; 
 
	//-------------------------------------------------------------------------
    
	/** specifies the text line color (RGB) of the control.
	 */
	[property] long TextLineColor;
    
	//-------------------------------------------------------------------------
    
	/** specifies that the text is treated as a number.
	 */
	[property] boolean TreatAsNumber;
    
};

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

}; }; }; };

#endif
