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
  20
  21
  22  module com {  module sun {  module star {  module form {
  23
  24
  25 /** allows to create columns to be added into a grid control model.
  26
  27     <p>Grid columns (more precise: models of grid columns) are direct children of
  28     the grid control model they belong to. Grid columns can't be created on a global
  29     service factory, instead, you need to create them on the grid, where you want to
  30     insert them later on.</p>
  31
  32     @see com::sun::star::form::component::GridControl
  33  */
  34 published interface XGridColumnFactory: com::sun::star::uno::XInterface
  35 {
  36
  37     /** creates a new column object
  38
  39         @param aColumnType
  40             the type of column to be created
  41
  42         @returns
  43             the new column object
  44
  45         @throws com::sun::star::lang::IllegalArgumentException
  46             if aColumnType is not available.
  47      */
  48     com::sun::star::beans::XPropertySet createColumn( [in] string aColumnType )
  49             raises( com::sun::star::lang::IllegalArgumentException );
  50
  51
  52     /** returns a list of available column types.
  53
  54         @returns
  55             a list of column types.
  56      */
  57     sequence<string> getColumnTypes();
  58 };
  59
  60
  61 }; }; }; };
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */