offapi/com/sun/star/sdb/ColumnSettings.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ColumnSettings.idl,v $
  10  * $Revision: 1.13 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdb_ColumnSettings_idl__
  31 #define __com_sun_star_sdb_ColumnSettings_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36
  37  module com {  module sun {  module star {  module sdb {
  38
  39
  40 /** describes the common properties of a database column.
  41  */
  42 published service ColumnSettings
  43 {
  44     interface com::sun::star::beans::XPropertySet;
  45
  46
  47     /** contains the index of the number format that is used for the
  48         column.
  49
  50         <p>The proper value can be determined by using the
  51         <type scope="com::sun::star::util">XNumberFormatter</type>
  52         interface.
  53         </p>
  54         <p>
  55         If the value is
  56         <void/>
  57         , a default numberformat should be used according to the datatype of the column.
  58         </p>
  59
  60     */
  61     [property] long FormatKey;
  62
  63
  64     /** specifies the alignment of columns text.
  65
  66         <pre>
  67         0: left
  68         1: center
  69         2: right
  70         </pre>
  71         <p>
  72         If the value is
  73         <void/>
  74         , a default alignment should be used according
  75         to the datatype of the column.
  76         </p>
  77      */
  78     [property] long Align;
  79
  80
  81     /** specifies the width of the column displayed in a grid, the unit is 10THMM.
  82
  83         <p>
  84         If the value is
  85         <void/>
  86         , a default width should be used according to the label of the column.
  87         </p>
  88      */
  89     [property] long Width;
  90
  91
  92     /** Position of the column within a grid.
  93
  94         <p>
  95         If the value is
  96         <void/>
  97         , the default position should be taken according.
  98         </p>
  99      */
 100     [property] long Position;
 101
 102
 103     /** determines whether the column should be displayed or not.
 104      */
 105     [property] boolean Hidden;
 106
 107
 108     /** indicates a control model whichs defines the settings for layouting.
 109         The default is
 110         <NULL/>
 111         .
 112      */
 113     [optional, property] com::sun::star::beans::XPropertySet ControlModel;
 114
 115     /** describes an optional help text which can be used by UI components
 116         when representing this column.
 117         The default is
 118         <NULL/>
 119         .
 120     */
 121     [optional, property] string HelpText;
 122
 123     /** describes the default value which should be displayed by a control when moving to a new row.
 124         The default is
 125         <NULL/>
 126         .
 127     */
 128     [optional, property] string ControlDefault;
 129 };
 130
 131 //=============================================================================
 132
 133 }; }; }; };
 134
 135 /*===========================================================================
 136 ===========================================================================*/
 137 #endif