merged tag ooo/OOO330_m14
[LibreOffice.git] / offapi / com / sun / star / form / XGridColumnFactory.idl
blob76d1b3735b9f6e15d7fe07a30116d02327fc0b20
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * This file is part of OpenOffice.org.
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.
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).
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.
26 ************************************************************************/
27 #ifndef __com_sun_star_form_XGridColumnFactory_idl__
28 #define __com_sun_star_form_XGridColumnFactory_idl__
30 #ifndef __com_sun_star_uno_XInterface_idl__
31 #include <com/sun/star/uno/XInterface.idl>
32 #endif
34 #ifndef __com_sun_star_beans_XPropertySet_idl__
35 #include <com/sun/star/beans/XPropertySet.idl>
36 #endif
38 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
39 #include <com/sun/star/lang/IllegalArgumentException.idl>
40 #endif
43 //=============================================================================
45 module com { module sun { module star { module form {
47 //=============================================================================
49 /** allows to create columns to be added into a grid control model.
51 <p>Grid columns (more precise: models of grid columns) are direct children of
52 the grid control model they belong to. Grid columns can't be created on a global
53 service factory, instead, you need to create them on the grid, where you want to
54 insert them later on.</p>
56 @see com::sun::star::form::component::GridControl
58 published interface XGridColumnFactory: com::sun::star::uno::XInterface
60 //-------------------------------------------------------------------------
62 /** creates a new column object
64 @param aColumnType
65 the type of column to be created
67 @returns
68 the new column object
70 @throws com::sun::star::lang::IllegalArgumentException
71 if <arg>aColumnType</arg> is not available.
73 com::sun::star::beans::XPropertySet createColumn( [in] string aColumnType )
74 raises( com::sun::star::lang::IllegalArgumentException );
76 //-------------------------------------------------------------------------
78 /** returns a list of available column types.
80 @returns
81 a list of column types.
83 sequence<string> getColumnTypes();
86 //=============================================================================
88 }; }; }; };
90 /*=============================================================================
92 =============================================================================*/
93 #endif