1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_form_component_NavigationToolBar_idl__
24#define __com_sun_star_form_component_NavigationToolBar_idl__
25
26#ifndef __com_sun_star_form_FormControlModel_idl__
27#include <com/sun/star/form/FormControlModel.idl>
28#endif
29#ifndef __com_sun_star_awt_FontDescriptor_idl__
30#include <com/sun/star/awt/FontDescriptor.idl>
31#endif
32
33//=============================================================================
34
35 module com {  module sun {  module star {  module form {  module component {
36
37//=============================================================================
38
39/** This service specifies the model for control which provides controller
40    functionality for a <type>DataForm</type>, such as navigating or filtering
41    the form.
42 */
43service NavigationToolBar
44{
45	service com::sun::star::form::FormControlModel;
46
47	//-------------------------------------------------------------------------
48	/** denotes the border style of the control.
49
50		Allowed values are
51        <ul><li><b>0</b>: no border at all</li>
52            <li><b>1</b>: 3D border</li>
53            <li><b>2</b>: simple flat</li>
54		</ul>
55	 */
56	[property] short Border;
57
58	//-------------------------------------------------------------------------
59	/** determines whether the control is enabled or disabled.
60	 */
61	[property] boolean Enabled;
62
63	//-------------------------------------------------------------------------
64	/** contains the font attributes for the text in the control
65	 */
66	[property] com::sun::star::awt::FontDescriptor FontDescriptor;
67
68	//-------------------------------------------------------------------------
69	/** specifies the text color (as RGB value) of the control.
70	 */
71	[property] long TextColor;
72
73	//-------------------------------------------------------------------------
74	/** specifies the text line color (as RGB value) of the control.
75
76        <p>This color is used if the <member>FontDescriptor</member> defines
77        that the text in the control should be underlined or stroke out.</p>
78	 */
79	[property] long TextLineColor;
80
81	//-------------------------------------------------------------------------
82	/** specifies the relief for the font described in <member>FontDescriptor</member>
83
84        <p>The value must be one of the <type scope="com::sun::star::text">FontRelief</type>
85        constants.</p>
86	 */
87	[property] long FontRelief;
88
89	//-------------------------------------------------------------------------
90	/** specifies the emphasis mark for the font described in <member>FontDescriptor</member>
91
92        <p>The value must be one of the <type scope="com::sun::star::text">FontEmphasis</type>
93        constants.</p>
94	 */
95	[property] long FontEmphasisMark;
96
97	//-------------------------------------------------------------------------
98    /** specifies the size of the icons in the control
99
100        <p>At least the following values are to be supported:
101        <ul><li>0: small icons (16x16)</li>
102            <li>1: medium size icons (26x26)</li>
103        </ul>
104    */
105    [property] short IconSize;
106
107	//-------------------------------------------------------------------------
108    /** determines whether the control should provide functionality for positioning the
109        parent form
110    */
111    [property] boolean ShowPosition;
112
113	//-------------------------------------------------------------------------
114    /** determines whether the control should provide functionality for navigating the
115        parent form
116    */
117    [property] boolean ShowNavigation;
118
119	//-------------------------------------------------------------------------
120    /** determines whether the control should provide functionality for acting on the current record
121        of the parent form
122    */
123    [property] boolean ShowRecordActions;
124
125	//-------------------------------------------------------------------------
126    /** determines whether the control should provide functionality for filtering and sorting the
127        parent form
128    */
129    [property] boolean ShowFilterSort;
130
131	//-------------------------------------------------------------------------
132    /** specifies a repeat delay for the control
133
134        <p>Some buttons of a NavigationToolBar may show repeating behaviour, e.g. may be
135        repeatedly triggered when the user keeps the mouse pressed over such a button.<br/>
136        The delay between two such triggers (in milliseconds) is specified with this property.
137        </p>
138    */
139    [property] long RepeatDelay;
140};
141
142//=============================================================================
143
144}; }; }; }; };
145
146#endif
147