offapi/com/sun/star/awt/grid/XGridColumn.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 module com {  module sun {  module star {  module awt {  module grid {
  22
  23
  24 /** The XGridColumn defines the properties and behavior of a column
  25     in a grid control.
  26     @since OOo 3.3
  27  */
  28 published interface XGridColumn
  29 {
  30     /** implements life time control for the component
  31     */
  32     interface ::com::sun::star::lang::XComponent;
  33
  34     /** allows cloning the complete grid column
  35     */
  36     interface ::com::sun::star::util::XCloneable;
  37
  38     /** specifies an identifier of the column
  39
  40         <p>This identifier will not be evaluated by the grid control, or its model. It is merely for clients
  41         to identify particular columns.</p>
  42     */
  43     [attribute] any Identifier;
  44
  45     /** specifies the current width of the column.
  46     */
  47     [attribute] long ColumnWidth;
  48
  49     /** specifies the minimal width the column can have.
  50     */
  51     [attribute] long MinWidth;
  52
  53     /** specifies the maximal width the column can have.
  54     */
  55     [attribute] long MaxWidth;
  56
  57     /** controls whether or not the column's width is fixed or not.
  58
  59         <p>If this is `TRUE`, the user can interactively change the column's width. Also, the column is subject to
  60         auto-resizing, if its #Flexibility attribute is greater <code>0</code>.</p>
  61     */
  62     [attribute] boolean Resizeable;
  63
  64     /** specifies the flexibility of the column when it is automatically resized due to the grid control as a whole
  65         being resized.
  66
  67         <p>Specify <code>0</code> here if you do not want the column to be resized automatically.</p>
  68
  69         <p>If a column has a flexibility greater than 0, it is set in relationship to the flexibility of all
  70         other such columns, and the respective widths of the columns are changed in the same relationship.</p>
  71
  72         <p>Note that a column's flexibility is ignored if its #Resizeable attribute is
  73         `FALSE`.</p>
  74
  75         <p>A column's flexibility cannot be negative, attempts to set a negative value will raise an exception.</p>
  76     */
  77     [attribute] long Flexibility
  78     {
  79         set raises ( ::com::sun::star::lang::IllegalArgumentException );
  80     };
  81
  82     /** Specifies the horizontal alignment of the content in the control.
  83      */
  84     [attribute] ::com::sun::star::style::HorizontalAlignment HorizontalAlign;
  85
  86     /** A title is displayed in the column header row if UnoControlGridModel::ShowColumnHeader() is set to `TRUE`**/
  87     [attribute] string Title;
  88
  89     /** is the help text associated with the column.
  90
  91         <p>A grid control will usually display a column's help text as tooltip.</p>
  92     */
  93     [attribute] string HelpText;
  94
  95     /** denotes the index of the column within the grid column model it belongs to
  96
  97         <p>If the column is not yet part of a column model, <code>Index</code> is -1.</p>
  98     */
  99     [attribute, readonly] long Index;
 100
 101     /** denotes the index of the data column which should be used to fetch this grid column's data
 102
 103         <p>A grid control has a column model and a data model, both containing a possibly different number of columns.
 104         The <code>DataColumnIndex</code> attribute defines the index of the column within the data model, which should
 105         be used to retrieve actual data.</p>
 106
 107         <p>Using this, you can do runtime changes to the column model, i.e. insertion and removal of columns, without
 108         necessarily needing to adjust the data model, too.</p>
 109
 110         <p>If <code>DataColumnIndex</code> is negative, the it will be ignored, then the column's index within its
 111         column model, as determined by the #Index attribute, will be used.</p>
 112     */
 113     [attribute] long DataColumnIndex;
 114
 115     /** Adds a listener for the GridColumnEvent posted after the grid changes.
 116         @param Listener
 117             the listener to add.
 118     */
 119     void addGridColumnListener( [in] XGridColumnListener  Listener);
 120
 121
 122     /** Removes a listener previously added with addColumnListener().
 123         @param Listener
 124             the listener to remove.
 125     */
 126     void removeGridColumnListener( [in] XGridColumnListener Listener);
 127 };
 128
 129
 130 }; }; }; }; };
 131
 132 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */