office-gobmx/offapi/com/sun/star/awt/UnoControlSpinButtonModel.idl
Kurt Zenker 381b7c9cbe INTEGRATION: CWS sdk10 (1.2.64); FILE MERGED
2004/02/10 15:39:54 mi 1.2.64.1: #i18677# color/long -> Color
2004-05-19 09:36:55 +00:00

198 lines
6.7 KiB
Text

/*************************************************************************
*
* $RCSfile: UnoControlSpinButtonModel.idl,v $
*
* $Revision: 1.3 $
*
* last change: $Author: kz $ $Date: 2004-05-19 10:36:55 $
*
* 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_UnoControlSpinButtonModel_idl__
#define __com_sun_star_awt_UnoControlSpinButtonModel_idl__
#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
//=============================================================================
module com { module sun { module star { module awt {
//=============================================================================
/** specifies the standard model of an <type>UnoControlSpinButton</type>.
<p>A spin button is a control which has a numeric value associated with it,
and allows to change this value using two spin buttons.</p>
<p>A spin button is similar to a scroll bar, but it usually has no
(own) visual representation of the associated value, but is used to propagate
it's value to other controls.</p>
@see UnoControlScrollBarModel
*/
service UnoControlSpinButtonModel
{
service com::sun::star::awt::UnoControlModel;
//-------------------------------------------------------------------------
/** specifies the border style of the control.
<pre>
0: No border
1: 3D border
2: simple border
</pre>
*/
[property] short Border;
//-------------------------------------------------------------------------
/** determines whether the control is enabled or disabled.
*/
[property] boolean Enabled;
//-------------------------------------------------------------------------
/** specifies the help text of the control.
*/
[property] string HelpText;
//-------------------------------------------------------------------------
/** specifies the help URL of the control.
*/
[property] string HelpURL;
//-------------------------------------------------------------------------
/** specifies the increment by which the value is changed when using operating
the spin button.
*/
[property] long SpinIncrement;
//-------------------------------------------------------------------------
/** specifies the <type>ScrollBarOrientation</type> of the control.
*/
[property] long Orientation;
//-------------------------------------------------------------------------
/** specifies whether the control will be printed with the document.
*/
[property] boolean Printable;
//-------------------------------------------------------------------------
/** specifies the current value of the control.
*/
[property] long SpinValue;
//-------------------------------------------------------------------------
/** specifies the minimum value of the control.
*/
[property] long SpinValueMin;
//-------------------------------------------------------------------------
/** specifies the maximum value of the control.
*/
[property] long SpinValueMax;
//-------------------------------------------------------------------------
/** specifies the RGB color to be used for the control
*/
[property] com::sun::star::util::Color BackgroundColor;
//-------------------------------------------------------------------------
/** specifies the RGB color to be used when painting symbols which are
part of the control's appearance, such as the arrow buttons.
*/
[property] com::sun::star::util::Color SymbolColor;
//-------------------------------------------------------------------------
/** specifies whether the mouse should show repeating behaviour, i.e.
repeatedly trigger an action when keeping pressed.
*/
[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 spinning the value), 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>
*/
[property] long RepeatDelay;
};
//=============================================================================
}; }; }; };
#endif