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_sdb_ColumnSettings_idl__
24#define __com_sun_star_sdb_ColumnSettings_idl__
25
26#ifndef __com_sun_star_beans_XPropertySet_idl__
27#include <com/sun/star/beans/XPropertySet.idl>
28#endif
29
30 module com {  module sun {  module star {  module sdb {
31
32
33/** describes the common properties of a database column.
34 */
35published service ColumnSettings
36{
37	interface com::sun::star::beans::XPropertySet;
38
39
40	/** contains the index of the number format that is used for the
41		column.
42
43		<p>The proper value can be determined by using the
44		<type scope="com::sun::star::util">XNumberFormatter</type>
45		interface.
46		</p>
47		<p>
48		If the value is
49		<void/>
50		, a default numberformat should be used according to the datatype of the column.
51		</p>
52
53	*/
54	[property] long FormatKey;
55
56
57	/** specifies the alignment of columns text.
58
59		<pre>
60		0: left
61		1: center
62		2: right
63		</pre>
64		<p>
65		If the value is
66		<void/>
67		, a default alignment should be used according
68		to the datatype of the column.
69		</p>
70	 */
71	[property] long Align;
72
73
74	/** specifies the width of the column displayed in a grid, the unit is 10THMM.
75
76		<p>
77		If the value is
78		<void/>
79		, a default width should be used according to the label of the column.
80		</p>
81	 */
82	[property] long Width;
83
84
85	/** Position of the column within a grid.
86
87		<p>
88		If the value is
89		<void/>
90		, the default position should be taken according.
91		</p>
92	 */
93	[property] long Position;
94
95
96	/** determines whether the column should be displayed or not.
97	 */
98	[property] boolean Hidden;
99
100
101	/** indicates a control model whichs defines the settings for layouting.
102		The default is
103		<NULL/>
104		.
105	 */
106	[optional, property] com::sun::star::beans::XPropertySet ControlModel;
107
108	/** describes an optional help text which can be used by UI components
109		when representing this column.
110		The default is
111		<NULL/>
112		.
113	*/
114	[optional, property] string HelpText;
115
116	/** describes the default value which should be displayed by a control when moving to a new row.
117		The default is
118		<NULL/>
119		.
120	*/
121	[optional, property] string ControlDefault;
122};
123
124//=============================================================================
125
126}; }; }; };
127
128/*===========================================================================
129===========================================================================*/
130#endif
131