~ubuntu-branches/ubuntu/trusty/guile-gnome-platform/trusty-proposed

« back to all changes in this revision

Viewing changes to gtk/doc/gtk/defuns-gtkiconview.xml.texi

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Rottmann
  • Date: 2009-03-01 22:51:48 UTC
  • mfrom: (1.1.2 upstream) (3.2.1 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090301225148-5cubt342wiv8jpmf
Tags: 2.16.1-1
* New upstream release.
* Upstream bumped API, hence all package names changed from
  guile-gnome0-* to guile-gnome2-*.
* Standards-Version 3.8.0 (no changes).
* Remove unused guile-gnome2-cairo.install file.
* Added ${misc:Depends} to all packages.
* Do not build-depend on a -1 revision of the g-wrap packages.
* Add a proper "Copyright YEARS AUTHORS" line to debian/copyright.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
@c %start of fragment
3
3
 
4
4
@deftp Class <gtk-icon-view>
5
 
This @code{<gobject>} class defines the following properties:
 
5
Derives from @code{<gtk-cell-layout>}, @code{<gtk-container>}.
 
6
 
 
7
This class defines the following slots:
6
8
 
7
9
@table @code
8
10
@item pixbuf-column
9
 
Model column used to retrieve the icon pixbuf from@item text-column
10
 
Model column used to retrieve the text from@item markup-column
11
 
Model column used to retrieve the text if using Pango markup@item selection-mode
12
 
The selection mode@item orientation
13
 
How the text and icon of each item are positioned relative to each other@item model
14
 
The model for the icon view@item columns
15
 
Number of columns to display@item item-width
16
 
The width used for each item@item spacing
17
 
Space which is inserted between cells of an item@item row-spacing
18
 
Space which is inserted between grid rows@item column-spacing
19
 
Space which is inserted between grid columns@item margin
20
 
Space which is inserted at the edges of the icon view@item reorderable
21
 
View is reorderable@item tooltip-column
22
 
The column in the model containing the tooltip texts for the items@end table
 
11
Model column used to retrieve the icon pixbuf from
 
12
 
 
13
@item text-column
 
14
Model column used to retrieve the text from
 
15
 
 
16
@item markup-column
 
17
Model column used to retrieve the text if using Pango markup
 
18
 
 
19
@item selection-mode
 
20
The selection mode
 
21
 
 
22
@item orientation
 
23
How the text and icon of each item are positioned relative to each other
 
24
 
 
25
@item model
 
26
The model for the icon view
 
27
 
 
28
@item columns
 
29
Number of columns to display
 
30
 
 
31
@item item-width
 
32
The width used for each item
 
33
 
 
34
@item spacing
 
35
Space which is inserted between cells of an item
 
36
 
 
37
@item row-spacing
 
38
Space which is inserted between grid rows
 
39
 
 
40
@item column-spacing
 
41
Space which is inserted between grid columns
 
42
 
 
43
@item margin
 
44
Space which is inserted at the edges of the icon view
 
45
 
 
46
@item reorderable
 
47
View is reorderable
 
48
 
 
49
@item tooltip-column
 
50
The column in the model containing the tooltip texts for the items
 
51
 
 
52
@end table
23
53
 
24
54
@end deftp
25
55
 
249
279
 
250
280
@end deffn
251
281
 
252
 
@deffn Function gtk-icon-view-get-item-at-pos  (self@tie{}@code{<gtk-icon-view>}) (x@tie{}@code{int}) (y@tie{}@code{int}) (path@tie{}@code{<gtk-tree-path**>}) (cell@tie{}@code{<gtk-cell-renderer**>}) @result{}@tie{} (ret@tie{}@code{bool})
253
 
@deffnx Method get-item-at-pos
254
 
Finds the path at the point (@var{x}, @var{y}), relative to widget coordinates.
255
 
In contrast to @code{gtk-icon-view-get-path-at-pos}, this function also obtains
256
 
the cell at the specified position. The returned path should be freed with
257
 
@code{gtk-tree-path-free}.
258
 
 
259
 
@table @var
260
 
@item icon-view
261
 
A @code{<gtk-icon-view>}.
262
 
 
263
 
@item x
264
 
The x position to be identified
265
 
 
266
 
@item y
267
 
The y position to be identified
268
 
 
269
 
@item path
270
 
Return location for the path, or @samp{@code{#f}}
271
 
 
272
 
@item cell
273
 
Return location for the renderer responsible for the cell at (@var{x}, @var{y}),
274
 
or @samp{@code{#f}}
275
 
 
276
 
@item ret
277
 
@samp{@code{#t}} if an item exists at the specified position
278
 
 
279
 
@end table
280
 
 
281
 
Since 2.8
282
 
 
283
 
@end deffn
284
 
 
285
282
@deffn Function gtk-icon-view-set-cursor  (self@tie{}@code{<gtk-icon-view>}) (path@tie{}@code{<gtk-tree-path>}) (cell@tie{}@code{<gtk-cell-renderer>}) (start_editing@tie{}@code{bool})
286
283
@deffnx Method set-cursor
287
284
Sets the current keyboard focus to be at @var{path}, and selects it. This is
313
310
 
314
311
@end deffn
315
312
 
316
 
@deffn Function gtk-icon-view-get-cursor  (self@tie{}@code{<gtk-icon-view>}) (path@tie{}@code{<gtk-tree-path**>}) (cell@tie{}@code{<gtk-cell-renderer**>}) @result{}@tie{} (ret@tie{}@code{bool})
317
 
@deffnx Method get-cursor
318
 
Fills in @var{path} and @var{cell} with the current cursor path and cell. If the
319
 
cursor isn't currently set, then *@var{path} will be @samp{@code{#f}}. If no
320
 
cell currently has focus, then *@var{cell} will be @samp{@code{#f}}.
321
 
 
322
 
The returned @code{<gtk-tree-path>} must be freed with
323
 
@code{gtk-tree-path-free}.
324
 
 
325
 
@table @var
326
 
@item icon-view
327
 
A @code{<gtk-icon-view>}
328
 
 
329
 
@item path
330
 
Return location for the current cursor path, or @samp{@code{#f}}
331
 
 
332
 
@item cell
333
 
Return location the current focus cell, or @samp{@code{#f}}
334
 
 
335
 
@item ret
336
 
@samp{@code{#t}} if the cursor is set.
337
 
 
338
 
@end table
339
 
 
340
 
Since 2.8
341
 
 
342
 
@end deffn
343
 
 
344
313
@deffn Function gtk-icon-view-set-selection-mode  (self@tie{}@code{<gtk-icon-view>}) (mode@tie{}@code{<gtk-selection-mode>})
345
314
@deffnx Method set-selection-mode
346
315
Sets the selection mode of the @var{icon-view}.
793
762
 
794
763
@end deffn
795
764
 
796
 
@deffn Function gtk-icon-view-get-visible-range  (self@tie{}@code{<gtk-icon-view>}) (start_path@tie{}@code{<gtk-tree-path**>}) (end_path@tie{}@code{<gtk-tree-path**>}) @result{}@tie{} (ret@tie{}@code{bool})
797
 
@deffnx Method get-visible-range
798
 
Sets @var{start-path} and @var{end-path} to be the first and last visible path.
799
 
Note that there may be invisible paths in between.
800
 
 
801
 
Both paths should be freed with @code{gtk-tree-path-free} after use.
802
 
 
803
 
@table @var
804
 
@item icon-view
805
 
A @code{<gtk-icon-view>}
806
 
 
807
 
@item start-path
808
 
Return location for start of region, or @samp{@code{#f}}
809
 
 
810
 
@item end-path
811
 
Return location for end of region, or @samp{@code{#f}}
812
 
 
813
 
@item ret
814
 
@samp{@code{#t}}, if valid paths were placed in @var{start-path} and
815
 
@var{end-path}
816
 
 
817
 
@end table
818
 
 
819
 
Since 2.8
820
 
 
821
 
@end deffn
822
 
 
823
765
@deffn Function gtk-icon-view-unset-model-drag-dest  (self@tie{}@code{<gtk-icon-view>})
824
766
@deffnx Method unset-model-drag-dest
825
767
Undoes the effect of @code{gtk-icon-view-enable-model-drag-dest}.
899
841
 
900
842
@end deffn
901
843
 
902
 
@deffn Function gtk-icon-view-get-drag-dest-item  (self@tie{}@code{<gtk-icon-view>}) (path@tie{}@code{<gtk-tree-path**>}) (pos@tie{}@code{<gtk-icon-view-drop-position*>})
903
 
@deffnx Method get-drag-dest-item
904
 
Gets information about the item that is highlighted for feedback.
905
 
 
906
 
@table @var
907
 
@item icon-view
908
 
a @code{<gtk-icon-view>}
909
 
 
910
 
@item path
911
 
Return location for the path of the highlighted item, or @samp{@code{#f}}.
912
 
 
913
 
@item pos
914
 
Return location for the drop position, or @samp{@code{#f}}
915
 
 
916
 
@end table
917
 
 
918
 
Since 2.8
919
 
 
920
 
@end deffn
921
 
 
922
 
@deffn Function gtk-icon-view-get-dest-item-at-pos  (self@tie{}@code{<gtk-icon-view>}) (drag_x@tie{}@code{int}) (drag_y@tie{}@code{int}) (path@tie{}@code{<gtk-tree-path**>}) (pos@tie{}@code{<gtk-icon-view-drop-position*>}) @result{}@tie{} (ret@tie{}@code{bool})
923
 
@deffnx Method get-dest-item-at-pos
924
 
Determines the destination item for a given position.
925
 
 
926
 
@table @var
927
 
@item icon-view
928
 
a @code{<gtk-icon-view>}
929
 
 
930
 
@item drag-x
931
 
the position to determine the destination item for
932
 
 
933
 
@item drag-y
934
 
the position to determine the destination item for
935
 
 
936
 
@item path
937
 
Return location for the path of the item, or @samp{@code{#f}}.
938
 
 
939
 
@item pos
940
 
Return location for the drop position, or @samp{@code{#f}}
941
 
 
942
 
@item ret
943
 
whether there is an item at the given position.
944
 
 
945
 
@end table
946
 
 
947
 
Since 2.8
948
 
 
949
 
@end deffn
950
 
 
951
 
@deffn Function gtk-icon-view-create-drag-icon  (self@tie{}@code{<gtk-icon-view>}) (path@tie{}@code{<gtk-tree-path>}) @result{}@tie{} (ret@tie{}@code{<gdk-pixmap*>})
 
844
@deffn Function gtk-icon-view-create-drag-icon  (self@tie{}@code{<gtk-icon-view>}) (path@tie{}@code{<gtk-tree-path>}) @result{}@tie{} (ret@tie{}@code{<gdk-pixmap>})
952
845
@deffnx Method create-drag-icon
953
846
Creates a @code{<gdk-pixmap>} representation of the item at @var{path}. This
954
847
image is used for a drag icon.