1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_sdb_ColumnSettings_idl__ 24cdf0e10cSrcweir#define __com_sun_star_sdb_ColumnSettings_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySet_idl__ 27cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir module com { module sun { module star { module sdb { 31cdf0e10cSrcweir 32cdf0e10cSrcweir 33cdf0e10cSrcweir/** describes the common properties of a database column. 34cdf0e10cSrcweir */ 35cdf0e10cSrcweirpublished service ColumnSettings 36cdf0e10cSrcweir{ 37cdf0e10cSrcweir interface com::sun::star::beans::XPropertySet; 38cdf0e10cSrcweir 39cdf0e10cSrcweir 40cdf0e10cSrcweir /** contains the index of the number format that is used for the 41cdf0e10cSrcweir column. 42cdf0e10cSrcweir 43cdf0e10cSrcweir <p>The proper value can be determined by using the 44cdf0e10cSrcweir <type scope="com::sun::star::util">XNumberFormatter</type> 45cdf0e10cSrcweir interface. 46cdf0e10cSrcweir </p> 47cdf0e10cSrcweir <p> 48cdf0e10cSrcweir If the value is 49cdf0e10cSrcweir <void/> 50cdf0e10cSrcweir , a default numberformat should be used according to the datatype of the column. 51cdf0e10cSrcweir </p> 52cdf0e10cSrcweir 53cdf0e10cSrcweir */ 54cdf0e10cSrcweir [property] long FormatKey; 55cdf0e10cSrcweir 56cdf0e10cSrcweir 57cdf0e10cSrcweir /** specifies the alignment of columns text. 58cdf0e10cSrcweir 59cdf0e10cSrcweir <pre> 60cdf0e10cSrcweir 0: left 61cdf0e10cSrcweir 1: center 62cdf0e10cSrcweir 2: right 63cdf0e10cSrcweir </pre> 64cdf0e10cSrcweir <p> 65cdf0e10cSrcweir If the value is 66cdf0e10cSrcweir <void/> 67cdf0e10cSrcweir , a default alignment should be used according 68cdf0e10cSrcweir to the datatype of the column. 69cdf0e10cSrcweir </p> 70cdf0e10cSrcweir */ 71cdf0e10cSrcweir [property] long Align; 72cdf0e10cSrcweir 73cdf0e10cSrcweir 74cdf0e10cSrcweir /** specifies the width of the column displayed in a grid, the unit is 10THMM. 75cdf0e10cSrcweir 76cdf0e10cSrcweir <p> 77cdf0e10cSrcweir If the value is 78cdf0e10cSrcweir <void/> 79cdf0e10cSrcweir , a default width should be used according to the label of the column. 80cdf0e10cSrcweir </p> 81cdf0e10cSrcweir */ 82cdf0e10cSrcweir [property] long Width; 83cdf0e10cSrcweir 84cdf0e10cSrcweir 85cdf0e10cSrcweir /** Position of the column within a grid. 86cdf0e10cSrcweir 87cdf0e10cSrcweir <p> 88cdf0e10cSrcweir If the value is 89cdf0e10cSrcweir <void/> 90cdf0e10cSrcweir , the default position should be taken according. 91cdf0e10cSrcweir </p> 92cdf0e10cSrcweir */ 93cdf0e10cSrcweir [property] long Position; 94cdf0e10cSrcweir 95cdf0e10cSrcweir 96cdf0e10cSrcweir /** determines whether the column should be displayed or not. 97cdf0e10cSrcweir */ 98cdf0e10cSrcweir [property] boolean Hidden; 99cdf0e10cSrcweir 100cdf0e10cSrcweir 101cdf0e10cSrcweir /** indicates a control model whichs defines the settings for layouting. 102cdf0e10cSrcweir The default is 103cdf0e10cSrcweir <NULL/> 104cdf0e10cSrcweir . 105cdf0e10cSrcweir */ 106cdf0e10cSrcweir [optional, property] com::sun::star::beans::XPropertySet ControlModel; 107cdf0e10cSrcweir 108cdf0e10cSrcweir /** describes an optional help text which can be used by UI components 109cdf0e10cSrcweir when representing this column. 110cdf0e10cSrcweir The default is 111cdf0e10cSrcweir <NULL/> 112cdf0e10cSrcweir . 113cdf0e10cSrcweir */ 114cdf0e10cSrcweir [optional, property] string HelpText; 115cdf0e10cSrcweir 116cdf0e10cSrcweir /** describes the default value which should be displayed by a control when moving to a new row. 117cdf0e10cSrcweir The default is 118cdf0e10cSrcweir <NULL/> 119cdf0e10cSrcweir . 120cdf0e10cSrcweir */ 121cdf0e10cSrcweir [optional, property] string ControlDefault; 122cdf0e10cSrcweir}; 123cdf0e10cSrcweir 124cdf0e10cSrcweir//============================================================================= 125cdf0e10cSrcweir 126cdf0e10cSrcweir}; }; }; }; 127cdf0e10cSrcweir 128cdf0e10cSrcweir/*=========================================================================== 129cdf0e10cSrcweir===========================================================================*/ 130cdf0e10cSrcweir#endif 131