1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_form_component_NavigationToolBar_idl__
28#define __com_sun_star_form_component_NavigationToolBar_idl__
29
30#ifndef __com_sun_star_form_FormControlModel_idl__
31#include <com/sun/star/form/FormControlModel.idl>
32#endif
33#ifndef __com_sun_star_awt_FontDescriptor_idl__
34#include <com/sun/star/awt/FontDescriptor.idl>
35#endif
36
37//=============================================================================
38
39 module com {  module sun {  module star {  module form {  module component {
40
41//=============================================================================
42
43/** This service specifies the model for control which provides controller
44    functionality for a <type>DataForm</type>, such as navigating or filtering
45    the form.
46 */
47service NavigationToolBar
48{
49	service com::sun::star::form::FormControlModel;
50
51	//-------------------------------------------------------------------------
52	/** denotes the border style of the control.
53
54		Allowed values are
55        <ul><li><b>0</b>: no border at all</li>
56            <li><b>1</b>: 3D border</li>
57            <li><b>2</b>: simple flat</li>
58		</ul>
59	 */
60	[property] short Border;
61
62	//-------------------------------------------------------------------------
63	/** determines whether the control is enabled or disabled.
64	 */
65	[property] boolean Enabled;
66
67	//-------------------------------------------------------------------------
68	/** contains the font attributes for the text in the control
69	 */
70	[property] com::sun::star::awt::FontDescriptor FontDescriptor;
71
72	//-------------------------------------------------------------------------
73	/** specifies the text color (as RGB value) of the control.
74	 */
75	[property] long TextColor;
76
77	//-------------------------------------------------------------------------
78	/** specifies the text line color (as RGB value) of the control.
79
80        <p>This color is used if the <member>FontDescriptor</member> defines
81        that the text in the control should be underlined or stroke out.</p>
82	 */
83	[property] long TextLineColor;
84
85	//-------------------------------------------------------------------------
86	/** specifies the relief for the font described in <member>FontDescriptor</member>
87
88        <p>The value must be one of the <type scope="com::sun::star::text">FontRelief</type>
89        constants.</p>
90	 */
91	[property] long FontRelief;
92
93	//-------------------------------------------------------------------------
94	/** specifies the emphasis mark for the font described in <member>FontDescriptor</member>
95
96        <p>The value must be one of the <type scope="com::sun::star::text">FontEmphasis</type>
97        constants.</p>
98	 */
99	[property] long FontEmphasisMark;
100
101	//-------------------------------------------------------------------------
102    /** specifies the size of the icons in the control
103
104        <p>At least the following values are to be supported:
105        <ul><li>0: small icons (16x16)</li>
106            <li>1: medium size icons (26x26)</li>
107        </ul>
108    */
109    [property] short IconSize;
110
111	//-------------------------------------------------------------------------
112    /** determines whether the control should provide functionality for positioning the
113        parent form
114    */
115    [property] boolean ShowPosition;
116
117	//-------------------------------------------------------------------------
118    /** determines whether the control should provide functionality for navigating the
119        parent form
120    */
121    [property] boolean ShowNavigation;
122
123	//-------------------------------------------------------------------------
124    /** determines whether the control should provide functionality for acting on the current record
125        of the parent form
126    */
127    [property] boolean ShowRecordActions;
128
129	//-------------------------------------------------------------------------
130    /** determines whether the control should provide functionality for filtering and sorting the
131        parent form
132    */
133    [property] boolean ShowFilterSort;
134
135	//-------------------------------------------------------------------------
136    /** specifies a repeat delay for the control
137
138        <p>Some buttons of a NavigationToolBar may show repeating behaviour, e.g. may be
139        repeatedly triggered when the user keeps the mouse pressed over such a button.<br/>
140        The delay between two such triggers (in milliseconds) is specified with this property.
141        </p>
142    */
143    [property] long RepeatDelay;
144};
145
146//=============================================================================
147
148}; }; }; }; };
149
150#endif
151