offapi/com/sun/star/form/XGridColumnFactory.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_form_XGridColumnFactory_idl__
  20 #define __com_sun_star_form_XGridColumnFactory_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/beans/XPropertySet.idl>
  25
  26 #include <com/sun/star/lang/IllegalArgumentException.idl>
  27
  28
  29
  30  module com {  module sun {  module star {  module form {
  31
  32
  33 /** allows to create columns to be added into a grid control model.
  34
  35     <p>Grid columns (more precise: models of grid columns) are direct children of
  36     the grid control model they belong to. Grid columns can't be created on a global
  37     service factory, instead, you need to create them on the grid, where you want to
  38     insert them later on.</p>
  39
  40     @see com::sun::star::form::component::GridControl
  41  */
  42 published interface XGridColumnFactory: com::sun::star::uno::XInterface
  43 {
  44
  45     /** creates a new column object
  46
  47         @param aColumnType
  48             the type of column to be created
  49
  50         @returns
  51             the new column object
  52
  53         @throws com::sun::star::lang::IllegalArgumentException
  54             if aColumnType is not available.
  55      */
  56     com::sun::star::beans::XPropertySet createColumn( [in] string aColumnType )
  57             raises( com::sun::star::lang::IllegalArgumentException );
  58
  59
  60     /** returns a list of available column types.
  61
  62         @returns
  63             a list of column types.
  64      */
  65     sequence<string> getColumnTypes();
  66 };
  67
  68
  69 }; }; }; };
  70
  71 #endif
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */