summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/XGridColumnFactory.idl
blob: 276e8e283d3e6021a5d91e45fdc1fe36962ddfc5 (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
/*************************************************************************
 *
 *  $RCSfile: XGridColumnFactory.idl,v $
 *
 *  $Revision: 1.5 $
 *
 *  last change: $Author: mi $ $Date: 2002-10-03 13:04:32 $
 *
 *  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_form_XGridColumnFactory_idl__ 
#define __com_sun_star_form_XGridColumnFactory_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_beans_XPropertySet_idl__ 
#include <com/sun/star/beans/XPropertySet.idl> 
#endif 
 
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 
#include <com/sun/star/lang/IllegalArgumentException.idl> 
#endif 
 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module form { 
 
//============================================================================= 
 
/** allows to create columns to be added into a grid control model.

    <p>Grid columns (more precise: models of grid columns) are direct children of
    the grid control model they belong to. Grid columns can't be created on a global
    service factory, instead, you need to create them on the grid, where you want to
    insert them later on.</p>

    @see com::sun::star::form::component::GridControl
 */
interface XGridColumnFactory: com::sun::star::uno::XInterface
{ 
    //------------------------------------------------------------------------- 
     
    /** creates a new column object

        @param aColumnType
            the type of column to be created

        @returns
            the new column object

        @throws com::sun::star::lang::IllegalArgumentException
            if <arg>aColumnType</arg> is not available.			
     */
    com::sun::star::beans::XPropertySet createColumn( [in] string aColumnType ) 
            raises( com::sun::star::lang::IllegalArgumentException ); 
 
    //------------------------------------------------------------------------- 
     
    /** returns a list of available column types.

        @returns
            a list of column types.
     */
    sequence<string> getColumnTypes(); 
}; 
 
//============================================================================= 
 
}; }; }; }; 
 
/*============================================================================= 
 
    $Log: not supported by cvs2svn $
    Revision 1.4.16.3  2002/07/26 10:00:09  fs
    IDL review form layer
    
    Revision 1.4.16.2  2002/02/19 08:11:36  oj
    #96946# parameter,return value and exception description
    
    Revision 1.4.16.1  2002/02/18 14:48:42  oj
    #96946# parameter,return value and exception description
    
    Revision 1.4  2001/03/16 16:41:23  jsc
    remove interfaceheader with uik and remove [const] in method definitions
    
    Revision 1.3  2000/11/08 12:42:52  mi
    moved from api
    
    Revision 1.1.1.1  2000/09/18 23:35:17  hjs
    initial import
    
    Revision 1.5  2000/09/11 11:52:25  mi
    documentation merged from XML
     
    Revision 1.3  2000/03/31 07:40:22  dg 
    #74028# documentation completed 
     
    Revision 1.2  2000/02/07 11:24:32  mi 
    zu #70728# missing documentation marked 
 
    Revision 1.1.1.1  1999/11/11 09:48:42  jsc 
    new 
 
 
=============================================================================*/ 
#endif