xref: /AOO41X/main/offapi/com/sun/star/awt/UnoControlEditModel.idl (revision d1e7efc3a14909e0a68c915b160c0a3adcc02b1f)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_awt_UnoControlEditModel_idl__
#define __com_sun_star_awt_UnoControlEditModel_idl__

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

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

#ifndef __com_sun_star_util_Color_idl__
#include <com/sun/star/util/Color.idl>
#endif

#ifndef __com_sun_star_style_VerticalAlignment_idl__
#include <com/sun/star/style/VerticalAlignment.idl>
#endif

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

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

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

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

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

	/** specifies the horizontal alignment of the text in the control.

		<pre>
		0: left
		1: center
		2: right
		</pre>
	 */
	[property] short Align;

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

	/** If set to true an horizontal scrollbar will be added automaticly
        when needed.

        @since OpenOffice 2.3
	 */
	[optional, property] boolean AutoHScroll;

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

	/** If set to true an vertical scrollbar will be added automaticly
        when needed.

        @since OpenOffice 2.3
	 */
	[optional, property] boolean AutoVScroll;

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

	/** specifies the background color (RGB) of the control.
	 */
	[property] com::sun::star::util::Color BackgroundColor;

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

	/** specifies the border style of the control.

		<pre>
		0: No border
		1: 3D border
		2: simple border
		</pre>
	 */
	[property] short Border;

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

	/** specifies the color of the border, if present

        <p>Not every border style (see <member>Border</member>) may support coloring.
        For instance, usually a border with 3D effect will ignore the BorderColor setting.</p>

        @since OpenOffice 2.0
	 */
	[optional, property] long BorderColor;

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

	/** specifies the echo character for a password edit field.
	 */
	[optional, property] short EchoChar;

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

	/** 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 if hard line breaks will be returned in the
        <member>XTextComponent::getText</member> method.
	 */
	[property] boolean HardLineBreaks;

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

	/** specifies the help text of the control.
	 */
	[property] string HelpText;

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

	/** specifies the help URL of the control.
	 */
	[property] string HelpURL;

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

    /** specifies whether the selection in the control should be hidden when
        the control is not active (focused).

        @since OpenOffice 2.0
     */
    [optional, property] boolean HideInactiveSelection;

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

	/** specifies if the content of the control can be scrolled in
		the horizontal direction.
	 */
	[property] boolean HScroll;

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

	/** specifies which line end type should be used for multi line text

        <p>Controls working with this model care for this setting when the user enters
        text. Every line break entered into the control will be treated according to this
        setting, so that the <member>Text</member> property always contains only
        line ends in the format specified.</p>

        <p>Possible values are all constants from the <type>LineEndFormat</type> group.</p>

        <p>Note that this setting is usually not relevant when you set new text via the API.
        No matter which line end format is used in this new text then, usual control implementations
        should recognize all line end formats and display them properly.</p>

        @since OpenOffice 2.0
	 */
	[optional, property] short LineEndFormat;

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

	/** specifies the maximum character count.

        <p>There's no limitation, if set to 0.</p>
     */
	[property] short MaxTextLen;

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

	/** specifies that the control may have more than one line.
	 */
	[property] boolean MultiLine;

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

	/** specifies whether the control paints it background or not.

        @since OpenOffice 2.3
     */
    [optional, property] boolean PaintTransparent;

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

	/** 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 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] com::sun::star::util::Color TextColor;

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

	/** specifies the text line color (RGB) of the control.
	 */
	[property] com::sun::star::util::Color TextLineColor;

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

	/** specifies if the content of the control can be scrolled in
		the vertical direction.
	 */
	[property] boolean VScroll;

    /** denotes the writing mode used in the control, as specified in the
        <type scope="com::sun::star::text">WritingMode2</type> constants group.

        <p>Only <member scope="com::sun::star::text">WritingMode2::LR_TB</member> and
        <member scope="com::sun::star::text">WritingMode2::RL_TB</member> are supported at the moment.</p>

        @since OpenOffice 3.1
    */
    [optional, property] short WritingMode;

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

    /** specifies the vertical alignment of the text in the control.

        @since OpenOffice 3.3
	 */
    [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign;
};

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

}; }; }; };

#endif