summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdb/ColumnSettings.idl
blob: edc548b7a62493b42719a1b2bcfa8a217e5eb9eb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/*************************************************************************
 *
 *  $RCSfile: ColumnSettings.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: fs $ $Date: 2001-09-24 11:21:17 $
 *
 *  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_sdb_ColumnSettings_idl__
#define __com_sun_star_sdb_ColumnSettings_idl__

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

 module com {  module sun {  module star {  module sdb {


/** describes the common properties of a database column.
 */
service ColumnSettings
{
    interface com::sun::star::beans::XPropertySet;


    /** contains the index of the number format that is used for the
        column.

        <p>The proper value can be determined by using the
        <type scope="com::sun::star::util">XNumberFormatter</type>
        interface.
        </p>
        <p>
        If the value is <void/>, a default numberformat should be used according
        to the datatype of the column.</p>
     */
    [property] long FormatKey;


    /** specifies the alignment of columns text.

        <pre>
        0: left
        1: center
        2: right
        </pre>
        <p> If the value is <void/>, a default alignment should be used according
        to the datatype of the column.</p>
     */
    [property] long Align;


    /** specifies the width of the column displayed in a grid, the unit is 10THMM.

        <p> If the value is <void/>, a default width should be used according to the label
        of the column.      </p>
     */
    [property] long Width;


    /** Position of the column within a grid.

        <p> If the value is <void/>, the default position should be taken according.        </p>
     */
    [property] long Position;


    /** determines whether the column should be displayed or not.
     */
    [property] boolean Hidden;


    /** indicates a control model whichs defines the settings for layouting.
        The default is <NULL/>.
     */
    [optional, property] com::sun::star::beans::XPropertySet ControlModel;

    /** describes an optional help text which can be used by UI components when representing this column.
    */
    [optional, property] string HelpText;
};

//=============================================================================

}; }; }; };

/*===========================================================================
    $Log: not supported by cvs2svn $
    Revision 1.6  2001/09/19 12:04:14  fs
    #92159# +HelpText (optional)

    Revision 1.5  2000/12/19 13:59:38  mi
    syntax errors in documentation fixed

    Revision 1.4  2000/12/19 13:46:03  mi
    syntax errors in documentation fixed

    Revision 1.3  2000/11/08 12:43:30  mi
    moved from api

    Revision 1.1.1.1  2000/09/18 23:35:36  hjs
    initial import

    Revision 1.6  2000/09/11 11:52:39  mi
    documentation merged from XML

    Revision 1.4  2000/06/07 07:16:28  dg
    Align has to of type lang

    Revision 1.3  2000/06/07 07:01:01  dg
    don't use any for propertytypes

    Revision 1.2  2000/06/05 13:35:37  dg
    services changed

    Revision 1.1  2000/06/05 13:19:53  dg
    new services


===========================================================================*/
#endif