blob: 3e96e8451461ac8aa6c0d8a9c1b094b2ec7531e4 (
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_awt_grid_XGridColumnModel_idl__
#define __com_sun_star_awt_grid_XGridColumnModel_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/XComponent.idl>
#include <com/sun/star/util/XCloneable.idl>
#include <com/sun/star/awt/grid/XGridColumn.idl>
#include <com/sun/star/container/XContainer.idl>
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
module com { module sun { module star { module awt { module grid {
/** An instance of this interface is used by the UnoControlGrid to
retrieve the column structure that is displayed in the actual control.
If you do not need your own model implementation, you can also use the DefaultGridColumnModel.
@since OOo 3.3
*/
published interface XGridColumnModel
{
/** implements life time control for the component
*/
interface ::com::sun::star::lang::XComponent;
/** allows to register listeners to be notified when columns are inserted or removed
*/
interface ::com::sun::star::container::XContainer;
/** allows cloning the complete column model
*/
interface ::com::sun::star::util::XCloneable;
/** Returns the number of columns.
@returns
the number of columns.
*/
long getColumnCount();
/** creates a new column for use with the column model.
<p>The newly created column is not yet inserted into the column container, you need to call addColumn()
after you initialized the column object.</p>
*/
XGridColumn
createColumn();
/** Adds a column to the model.
<p>You should use the createColumn() member to create a new column. This gives
implementations of the <code>XGridColumnModel</code> interface the possibility to provide own column
implementations which extend the basic GridColumn type.</p>
<p>As soon as the column has been inserted into the model, the model takes ownership of it. This means when the
column is removed, or when the column model is disposed, the grid column is disposed as well.</p>
@param column
the column to add to the model.
@returns
the index of new created column.
@throws ::com::sun::star::lang::IllegalArgumentException
if the given column is not a valid element for the column container, or if it is `NULL`.
*/
long addColumn( [in] XGridColumn column )
raises ( ::com::sun::star::lang::IllegalArgumentException );
/** removes a column from the model
<p>The column object will be disposed upon removal.</p>
@param ColumnIndex
denotes the index of the column to remove
@throws ::com::sun::star::lang::IndexOutOfBoundsException
if <code>ColumnIndex</code> does not denote a valid column index.
*/
void removeColumn( [in] long ColumnIndex )
raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
/** Returns all columns of the model.
@returns
all columns associated with the model in a sequence of XGridColumn.
*/
sequence<XGridColumn> getColumns();
/** Returns a specific column.
@param index
the position of the requested column.
@returns
the requested column.
*/
XGridColumn getColumn( [in] long index)
raises ( ::com::sun::star::lang::IndexOutOfBoundsException );
/** Fills the model with the given number of default columns
<p>Existing columns will be removed before adding new columns. Listeners at the column model will
be notified one com::sun::star::container::XContainerListener::elementRemoved() event
for each removed column, and one com::sun::star::container::XContainerListener::elementInserted()
event for each insertion.</p>
@param elements
the number of default columns that should be set.
*/
void setDefaultColumns([in] long elements);
};
}; }; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
