diff options
Diffstat (limited to 'offapi/com/sun/star/form/component/RichTextControl.idl')
-rw-r--r-- | offapi/com/sun/star/form/component/RichTextControl.idl | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/offapi/com/sun/star/form/component/RichTextControl.idl b/offapi/com/sun/star/form/component/RichTextControl.idl new file mode 100644 index 000000000000..0566f658a197 --- /dev/null +++ b/offapi/com/sun/star/form/component/RichTextControl.idl @@ -0,0 +1,91 @@ +/************************************************************************* + * + * 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_component_RichTextControl_idl__ +#define __com_sun_star_form_component_RichTextControl_idl__ + +#ifndef __com_sun_star_awt_UnoControlEditModel_idl__ +#include <com/sun/star/awt/UnoControlEditModel.idl> +#endif + +#ifndef __com_sun_star_form_FormControlModel_idl__ +#include <com/sun/star/form/FormControlModel.idl> +#endif + +#ifndef __com_sun_star_text_TextRange_idl__ +#include <com/sun/star/text/TextRange.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module form { module component { + +//============================================================================= + +/** specifies a component which extends the <type scope="com::sun::star::awt">UnoControlEditModel</type> + with capabilities to display and input formatted text. +*/ +published service RichTextControl +{ + service com::sun::star::awt::UnoControlEditModel; + + service com::sun::star::form::FormControlModel; + + /** specifies capabilities to provide rich text, as opposed to the simple text provided by the + <type scope="com::sun::star::awt">UnoControlEditModel</type> + */ + service com::sun::star::text::TextRange; + + /** specifies whether text should be automatically wrapped to fit into the control. + + <p>If set to <TRUE/>, users need to manually press the enter key to insert a line break. + If set to <FALSE/>, text is automatically wrapped at the control border.</p> + */ + [property] boolean HardLineBreaks; + + /** specifies whether the control should display the text including all its formatting. + + <p>If this is set to <FALSE/>, the control will act as ordinary + <type scope="com::sun::star::awt">UnoControlEditModel</type>.</p> + + <p>If the property is set to <TRUE/>, the control will ignore the following properties: + <ul> + <li><member scope="com::sun::star::awt">UnoControlEditModel::EchoChar</member></li> + <li><member scope="com::sun::star::awt">UnoControlEditModel::MaxTextLen</member></li> + <li><member scope="com::sun::star::awt">UnoControlEditModel::MultiLine</member></li> + <li><member scope="com::sun::star::awt">UnoControlEditModel::Align</member></li> + </ul> + </p> + */ + [property] boolean RichText; +}; + +//============================================================================= + +}; }; }; }; }; + +#endif |