summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/grid/XGridColumn.idl
blob: 162d3bf8eacb77d921ee955f256a8017666a556e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_grid_XGridColumn_idl__ 
#define __com_sun_star_awt_grid_XGridColumn_idl__ 
 
#include <com/sun/star/lang/XComponent.idl>
#include <com/sun/star/style/HorizontalAlignment.idl>
#include <com/sun/star/awt/grid/XGridColumnListener.idl> 
#include <com/sun/star/util/XCloneable.idl> 
 
//============================================================================= 
 
module com {  module sun {  module star {  module awt {  module grid {
 
//============================================================================= 

/** The <type>XGridColumn</types> defines the properties and behavior of a column in a grid control
    @since OOo 3.3.0
 */     
interface XGridColumn
{ 
    /** implements life time control for the component
    */
    interface ::com::sun::star::lang::XComponent;

    /** allows cloning the complete grid column
    */
    interface ::com::sun::star::util::XCloneable;

    /** Specifies the an idendifier of the colomn.**/
    [attribute] any Identifier;

    /** Specifies the default column witdth. **/
    [attribute] long ColumnWidth;
    
    /** Specifies the preferred column witdth. **/
    [attribute] long PreferredWidth;

    /** Specifies the min column witdth. **/
    [attribute] long MinWidth;

    /** Specifies the max column witdth. **/
    [attribute] long MaxWidth;
    
    /** Specifies whether column has fixed size or not. **/
    [attribute] boolean Resizeable;
    
    /** Specifies the horizontal alignment of the content in the control.
     */
    [attribute] ::com::sun::star::style::HorizontalAlignment HorizontalAlign;
    
    /** A title is displayed in the colum header row if <method>UnoControlGridModel::ShowRowHeader</method> is set to <true/>**/
    [attribute] string Title;

    /** denotes the index of the column within the grid column model it belongs to
    
        <p>If the column is not yet part of a column model, <code>Index</code> is -1.</p>
    */
    [attribute, readonly] long Index;

    /** Adds a listener for the <type>GridColumnEvent</type> posted after the grid changes.
        @param Listener
            the listener to add.
    */     
    void addGridColumnListener( [in] XGridColumnListener  listener); 
 
    //------------------------------------------------------------------------- 

    /** Removes a listener previously added with <method>addColumnListener()</method>.
        @param Listener
            the listener to remove.
    */   
    void removeGridColumnListener( [in] XGridColumnListener listener); 
}; 
 
//============================================================================= 
 
}; }; }; }; }; 
 
#endif