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