offapi/com/sun/star/form/XGridColumnFactory.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: XGridColumnFactory.idl,v $
  10  * $Revision: 1.9 $
  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_form_XGridColumnFactory_idl__
  31 #define __com_sun_star_form_XGridColumnFactory_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_XPropertySet_idl__
  38 #include <com/sun/star/beans/XPropertySet.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  42 #include <com/sun/star/lang/IllegalArgumentException.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module form {
  49
  50 //=============================================================================
  51
  52 /** allows to create columns to be added into a grid control model.
  53
  54     <p>Grid columns (more precise: models of grid columns) are direct children of
  55     the grid control model they belong to. Grid columns can't be created on a global
  56     service factory, instead, you need to create them on the grid, where you want to
  57     insert them later on.</p>
  58
  59     @see com::sun::star::form::component::GridControl
  60  */
  61 published interface XGridColumnFactory: com::sun::star::uno::XInterface
  62 {
  63     //-------------------------------------------------------------------------
  64
  65     /** creates a new column object
  66
  67         @param aColumnType
  68             the type of column to be created
  69
  70         @returns
  71             the new column object
  72
  73         @throws com::sun::star::lang::IllegalArgumentException
  74             if <arg>aColumnType</arg> is not available.
  75      */
  76     com::sun::star::beans::XPropertySet createColumn( [in] string aColumnType )
  77             raises( com::sun::star::lang::IllegalArgumentException );
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** returns a list of available column types.
  82
  83         @returns
  84             a list of column types.
  85      */
  86     sequence<string> getColumnTypes();
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 /*=============================================================================
  94
  95 =============================================================================*/
  96 #endif