1
2@c %start of fragment
3
4@deftp Class <gtk-cell-view>
5Derives from @code{<gtk-cell-layout>}, @code{<gtk-widget>}.
6
7This class defines the following slots:
8
9@table @code
10@item background
11Background color as a string
12
13@item background-gdk
14Background color as a GdkColor
15
16@item background-set
17Whether this tag affects the background color
18
19@item model
20The model for cell view
21
22@end table
23
24@end deftp
25
26@deffn Function gtk-cell-view-new  @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
27Creates a new @code{<gtk-cell-view>} widget.
28
29@table @var
30@item ret
31A newly created @code{<gtk-cell-view>} widget.
32
33@end table
34
35Since 2.6
36
37@end deffn
38
39@deffn Function gtk-cell-view-new-with-text  (text@tie{}@code{mchars}) @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
40Creates a new @code{<gtk-cell-view>} widget, adds a
41@code{<gtk-cell-renderer-text>} to it, and makes its show @var{text}.
42
43@table @var
44@item text
45the text to display in the cell view
46
47@item ret
48A newly created @code{<gtk-cell-view>} widget.
49
50@end table
51
52Since 2.6
53
54@end deffn
55
56@deffn Function gtk-cell-view-new-with-markup  (markup@tie{}@code{mchars}) @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
57Creates a new @code{<gtk-cell-view>} widget, adds a
58@code{<gtk-cell-renderer-text>} to it, and makes its show @var{markup}. The text
59can text can be marked up with the Pango text markup language.
60
61@table @var
62@item markup
63the text to display in the cell view
64
65@item ret
66A newly created @code{<gtk-cell-view>} widget.
67
68@end table
69
70Since 2.6
71
72@end deffn
73
74@deffn Function gtk-cell-view-new-with-pixbuf  (pixbuf@tie{}@code{<gdk-pixbuf>}) @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
75Creates a new @code{<gtk-cell-view>} widget, adds a
76@code{<gtk-cell-renderer-pixbuf>} to it, and makes its show @var{pixbuf}.
77
78@table @var
79@item pixbuf
80the image to display in the cell view
81
82@item ret
83A newly created @code{<gtk-cell-view>} widget.
84
85@end table
86
87Since 2.6
88
89@end deffn
90
91@deffn Function gtk-cell-view-set-model  (self@tie{}@code{<gtk-cell-view>}) (model@tie{}@code{<gtk-tree-model>})
92@deffnx Method set-model
93Sets the model for @var{cell-view}. If @var{cell-view} already has a model set,
94it will remove it before setting the new model. If @var{model} is
95@samp{@code{#f}}, then it will unset the old model.
96
97@table @var
98@item cell-view
99a @code{<gtk-cell-view>}
100
101@item model
102a @code{<gtk-tree-model>}
103
104@end table
105
106Since 2.6
107
108@end deffn
109
110@deffn Function gtk-cell-view-set-displayed-row  (self@tie{}@code{<gtk-cell-view>}) (path@tie{}@code{<gtk-tree-path>})
111@deffnx Method set-displayed-row
112Sets the row of the model that is currently displayed by the
113@code{<gtk-cell-view>}. If the path is unset, then the contents of the cellview
114"stick" at their last value; this is not normally a desired result, but may be a
115needed intermediate state if say, the model for the @code{<gtk-cell-view>}
116becomes temporarily empty.
117
118@table @var
119@item cell-view
120a @code{<gtk-cell-view>}
121
122@item path
123a @code{<gtk-tree-path>} or @samp{@code{#f}} to unset.
124
125@end table
126
127Since 2.6
128
129@end deffn
130
131@deffn Function gtk-cell-view-get-displayed-row  (self@tie{}@code{<gtk-cell-view>}) @result{}@tie{} (ret@tie{}@code{<gtk-tree-path>})
132@deffnx Method get-displayed-row
133Returns a @code{<gtk-tree-path>} referring to the currently displayed row. If no
134row is currently displayed, @samp{@code{#f}} is returned.
135
136@table @var
137@item cell-view
138a @code{<gtk-cell-view>}
139
140@item ret
141the currently displayed row or @samp{@code{#f}}
142
143@end table
144
145Since 2.6
146
147@end deffn
148
149@deffn Function gtk-cell-view-get-size-of-row  (self@tie{}@code{<gtk-cell-view>}) (path@tie{}@code{<gtk-tree-path>}) (requisition@tie{}@code{<gtk-requisition>}) @result{}@tie{} (ret@tie{}@code{bool})
150@deffnx Method get-size-of-row
151Sets @var{requisition} to the size needed by @var{cell-view} to display the
152model row pointed to by @var{path}.
153
154@table @var
155@item cell-view
156a @code{<gtk-cell-view>}
157
158@item path
159a @code{<gtk-tree-path>}
160
161@item requisition
162return location for the size
163
164@item ret
165@samp{@code{#t}}
166
167@end table
168
169Since 2.6
170
171@end deffn
172
173@deffn Function gtk-cell-view-set-background-color  (self@tie{}@code{<gtk-cell-view>}) (color@tie{}@code{<gdk-color>})
174@deffnx Method set-background-color
175Sets the background color of @var{view}.
176
177@table @var
178@item cell-view
179a @code{<gtk-cell-view>}
180
181@item color
182the new background color
183
184@end table
185
186Since 2.6
187
188@end deffn
189
190@deffn Function gtk-cell-view-get-cell-renderers  (self@tie{}@code{<gtk-cell-view>}) @result{}@tie{} (ret@tie{}@code{glist-of})
191@deffnx Method get-cell-renderers
192Returns the cell renderers which have been added to @var{cell-view}.
193
194@table @var
195@item cell-view
196a @code{<gtk-cell-view>}
197
198@item ret
199a list of cell renderers. The list, but not the renderers has been newly
200allocated and should be freed with @code{g-list-free} when no longer needed.
201
202@end table
203
204Since 2.6
205
206@end deffn
207
208
209@c %end of fragment
210