diff options
Diffstat (limited to 'offapi/com/sun/star/awt/UnoControlButtonModel.idl')
| -rw-r--r-- | offapi/com/sun/star/awt/UnoControlButtonModel.idl | 282 |
1 files changed, 282 insertions, 0 deletions
diff --git a/offapi/com/sun/star/awt/UnoControlButtonModel.idl b/offapi/com/sun/star/awt/UnoControlButtonModel.idl new file mode 100644 index 000000000000..bbcf7000157e --- /dev/null +++ b/offapi/com/sun/star/awt/UnoControlButtonModel.idl @@ -0,0 +1,282 @@ +/************************************************************************* + * + * 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_UnoControlButtonModel_idl__ +#define __com_sun_star_awt_UnoControlButtonModel_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_style_VerticalAlignment_idl__ +#include <com/sun/star/style/VerticalAlignment.idl> +#endif +#ifndef com_sun_star_graphic_XGraphic_idl +#include <com/sun/star/graphic/XGraphic.idl> +#endif +#ifndef __com_sun_star_util_Color_idl__ +#include <com/sun/star/util/Color.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module awt { + +//============================================================================= + +/** specifies the standard model of an <type>UnoControlButton</type>. + */ +published service UnoControlButtonModel +{ + service com::sun::star::awt::UnoControlModel; + + //------------------------------------------------------------------------- + + /** specifies the horizontal alignment of the text in the control. + + <pre> + 0: left + 1: center + 2: right + </pre> + */ + [optional, property] short Align; + + //------------------------------------------------------------------------- + + /** specifies the background color (RGB) of the control. + */ + [property] com::sun::star::util::Color BackgroundColor; + + //------------------------------------------------------------------------- + + /** specifies that the button is the default button on the document. + */ + [property] boolean DefaultButton; + + //------------------------------------------------------------------------- + + /** determines whether the control is enabled or disabled. + */ + [property] boolean Enabled; + + //------------------------------------------------------------------------- + + /** specifies whether the button control should grab the focus when clicked. + + <p>If set to <TRUE/> (which is the default), the button control automatically grabs the + focus when the user clicks onto it with the mouse.<br/> + If set to <FALSE/>, the focus is preserved when the user operates the button control with + the mouse.</p> + + @since OOo 2.0.0 + */ + [optional, property] boolean FocusOnClick; + + //------------------------------------------------------------------------- + + /** 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 help text of the control. + */ + [property] string HelpText; + + //------------------------------------------------------------------------- + + /** specifies the help URL of the control. + */ + [property] string HelpURL; + + //------------------------------------------------------------------------- + + /** specifies the alignment of the image inside the button as + <type>ImageAlign</type> value. + */ + [property] short ImageAlign; + + //------------------------------------------------------------------------- + + /** specifies the position of the image, if any, relative to the text, if any + + <p>Valid values of this property are specified with <type>ImagePosition</type>.</p> + + <p>If this property is present, it supersedes the <member>ImageAlign</member> property - setting + one of both properties sets the other one to the best possible match.</p> + */ + [optional, property] short ImagePosition; + + //------------------------------------------------------------------------- + + /** specifies an URL to an image to use for the button. + @see Graphic + */ + [property] string ImageURL; + + //------------------------------------------------------------------------- + + /** specifies a graphic to be displayed at the button + + <p>If this property is present, it interacts with the <member>ImageURL</member>in the + following way: + <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset + to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member> + does not point to a valid image file.</li> + <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset + to an empty string.</li> + </ul></p> + + @since OOo 2.1 + */ + [optional, property, transient] com::sun::star::graphic::XGraphic Graphic; + + //------------------------------------------------------------------------- + + /** specifies the label of the control. + */ + [property] string Label; + + //------------------------------------------------------------------------- + + /** specifies that the text may be displayed on more than one line. + + @since OOo 2.0.0 + */ + [optional, property] boolean MultiLine; + + //------------------------------------------------------------------------- + + /** specifies that the control will be printed with the document. + */ + [property] boolean Printable; + + //------------------------------------------------------------------------- + + /** specifies the default action of the button as <type>PushButtonType</type> value. + */ + [property] short PushButtonType; + + //------------------------------------------------------------------------- + + /** specifies whether the control should show repeating behaviour. + + <p>Normally, when you click a button with the mouse, you need to + release the mouse button, and press it again. With this property + set to <TRUE/>, the button is repeatedly pressed while you hold + down the mouse button.</p> + + @since OOo 2.0.0 + */ + [optional, property] boolean Repeat; + + //------------------------------------------------------------------------- + + /** specifies the mouse repeat delay, in milliseconds. + + <p>When the user presses a mouse in a control area where this triggers + an action (such as pressing the button), then usual control implementations + allow to repeatedly trigger this action, without the need to release the + mouse button and to press it again. The delay between two such triggers + is specified with this property.</p> + + @since OOo 2.0.0 + */ + [optional, property] long RepeatDelay; + + //------------------------------------------------------------------------- + + /** specifies the state of the control. + */ + [property] short State; + + //------------------------------------------------------------------------- + + /** specifies that the control can be reached with the TAB key. + */ + [property] boolean Tabstop; + + //------------------------------------------------------------------------- + + /** 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 whether the button should toggle on a single operation. + + <p>If this property is set to <TRUE/>, a single operation of the button control (pressing space + while it is focused, or clicking onto it) toggles it between a <em>pressed</em> and a <em>not + pressed</em> state.</p> + + <p>The default for this property is <FALSE/>, which means the button behaves like a usual + push button.</p> + + @since OOo 2.0.0 + */ + [optional, property] boolean Toggle; + + //------------------------------------------------------------------------- + + /** specifies the vertical alignment of the text in the control. + + @since OOo 2.0.0 + */ + [optional, property] com::sun::star::style::VerticalAlignment VerticalAlign; + +}; + +//============================================================================= + +}; }; }; }; + +#endif |