PageRenderTime 47ms CodeModel.GetById 18ms RepoModel.GetById 1ms app.codeStats 0ms

/gtk+-3.4.4/gtk/gtkiconview.h

#
C Header | 261 lines | 192 code | 28 blank | 41 comment | 1 complexity | d9d661e79a15e2042419aae091d137bc MD5 | raw file
Possible License(s): LGPL-2.0, AGPL-3.0, LGPL-2.1 
    

  1. /* gtkiconview.h
    2. 

  2.  * Copyright (C) 2002, 2004  Anders Carlsson <andersca@gnome.org>
    3. 

  3.  *
    4. 

  4.  * This library is free software; you can redistribute it and/or
    5. 

  5.  * modify it under the terms of the GNU Library General Public
    6. 

  6.  * License as published by the Free Software Foundation; either
    7. 

  7.  * version 2 of the License, or (at your option) any later version.
    8. 

  8.  *
    9. 

  9.  * This library is distributed in the hope that it will be useful,
    10. 

  10.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    11. 

  11.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    12. 

  12.  * Library General Public License for more details.
    13. 

  13.  *
    14. 

  14.  * You should have received a copy of the GNU Library General Public
    15. 

  15.  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
    16. 

  16.  */
    17. 

  17. 

  18. #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
    19. 

  19. #error "Only <gtk/gtk.h> can be included directly."
    20. 

  20. #endif
    21. 

  21. 

  22. #ifndef __GTK_ICON_VIEW_H__
    23. 

  23. #define __GTK_ICON_VIEW_H__
    24. 

  24. 

  25. #include <gtk/gtkcontainer.h>
    26. 

  26. #include <gtk/gtktreemodel.h>
    27. 

  27. #include <gtk/gtkcellrenderer.h>
    28. 

  28. #include <gtk/gtkcellarea.h>
    29. 

  29. #include <gtk/gtkselection.h>
    30. 

  30. #include <gtk/gtktooltip.h>
    31. 

  31. 

  32. G_BEGIN_DECLS
    33. 

  33. 

  34. #define GTK_TYPE_ICON_VIEW            (gtk_icon_view_get_type ())
    35. 

  35. #define GTK_ICON_VIEW(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ICON_VIEW, GtkIconView))
    36. 

  36. #define GTK_ICON_VIEW_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ICON_VIEW, GtkIconViewClass))
    37. 

  37. #define GTK_IS_ICON_VIEW(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ICON_VIEW))
    38. 

  38. #define GTK_IS_ICON_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ICON_VIEW))
    39. 

  39. #define GTK_ICON_VIEW_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ICON_VIEW, GtkIconViewClass))
    40. 

  40. 

  41. typedef struct _GtkIconView           GtkIconView;
    42. 

  42. typedef struct _GtkIconViewClass      GtkIconViewClass;
    43. 

  43. typedef struct _GtkIconViewPrivate    GtkIconViewPrivate;
    44. 

  44. 

  45. /**
    46. 

  46.  * GtkIconViewForeachFunc:
    47. 

  47.  * @icon_view: a #GtkIconView
    48. 

  48.  * @path: The #GtkTreePath of a selected row
    49. 

  49.  * @data: user data
    50. 

  50.  *
    51. 

  51.  * A function used by gtk_icon_view_selected_foreach() to map all
    52. 

  52.  * selected rows.  It will be called on every selected row in the view.
    53. 

  53.  */
    54. 

  54. typedef void (* GtkIconViewForeachFunc)     (GtkIconView      *icon_view,
    55. 

  55. 					     GtkTreePath      *path,
    56. 

  56. 					     gpointer          data);
    57. 

  57. 

  58. /**
    59. 

  59.  * GtkIconViewDropPosition:
    60. 

  60.  * @GTK_ICON_VIEW_NO_DROP: no drop possible
    61. 

  61.  * @GTK_ICON_VIEW_DROP_INTO: dropped item replaces the item
    62. 

  62.  * @GTK_ICON_VIEW_DROP_LEFT: droppped item is inserted to the left
    63. 

  63.  * @GTK_ICON_VIEW_DROP_RIGHT: dropped item is inserted to the right
    64. 

  64.  * @GTK_ICON_VIEW_DROP_ABOVE: dropped item is inserted above
    65. 

  65.  * @GTK_ICON_VIEW_DROP_BELOW: dropped item is inserted below
    66. 

  66.  *
    67. 

  67.  * An enum for determining where a dropped item goes.
    68. 

  68.  */
    69. 

  69. typedef enum
    70. 

  70. {
    71. 

  71.   GTK_ICON_VIEW_NO_DROP,
    72. 

  72.   GTK_ICON_VIEW_DROP_INTO,
    73. 

  73.   GTK_ICON_VIEW_DROP_LEFT,
    74. 

  74.   GTK_ICON_VIEW_DROP_RIGHT,
    75. 

  75.   GTK_ICON_VIEW_DROP_ABOVE,
    76. 

  76.   GTK_ICON_VIEW_DROP_BELOW
    77. 

  77. } GtkIconViewDropPosition;
    78. 

  78. 

  79. struct _GtkIconView
    80. 

  80. {
    81. 

  81.   GtkContainer parent;
    82. 

  82. 

  83.   /*< private >*/
    84. 

  84.   GtkIconViewPrivate *priv;
    85. 

  85. };
    86. 

  86. 

  87. struct _GtkIconViewClass
    88. 

  88. {
    89. 

  89.   GtkContainerClass parent_class;
    90. 

  90. 

  91.   void    (* item_activated)         (GtkIconView      *icon_view,
    92. 

  92. 				      GtkTreePath      *path);
    93. 

  93.   void    (* selection_changed)      (GtkIconView      *icon_view);
    94. 

  94. 

  95.   /* Key binding signals */
    96. 

  96.   void    (* select_all)             (GtkIconView      *icon_view);
    97. 

  97.   void    (* unselect_all)           (GtkIconView      *icon_view);
    98. 

  98.   void    (* select_cursor_item)     (GtkIconView      *icon_view);
    99. 

  99.   void    (* toggle_cursor_item)     (GtkIconView      *icon_view);
    100. 

  100.   gboolean (* move_cursor)           (GtkIconView      *icon_view,
    101. 

  101. 				      GtkMovementStep   step,
    102. 

  102. 				      gint              count);
    103. 

  103.   gboolean (* activate_cursor_item)  (GtkIconView      *icon_view);
    104. 

  104. 

  105.   /* Padding for future expansion */
    106. 

  106.   void (*_gtk_reserved1) (void);
    107. 

  107.   void (*_gtk_reserved2) (void);
    108. 

  108.   void (*_gtk_reserved3) (void);
    109. 

  109.   void (*_gtk_reserved4) (void);
    110. 

  110. };
    111. 

  111. 

  112. GType          gtk_icon_view_get_type          (void) G_GNUC_CONST;
    113. 

  113. GtkWidget *    gtk_icon_view_new               (void);
    114. 

  114. GtkWidget *    gtk_icon_view_new_with_area     (GtkCellArea    *area);
    115. 

  115. GtkWidget *    gtk_icon_view_new_with_model    (GtkTreeModel   *model);
    116. 

  116. 

  117. void           gtk_icon_view_set_model         (GtkIconView    *icon_view,
    118. 

  118.  					        GtkTreeModel   *model);
    119. 

  119. GtkTreeModel * gtk_icon_view_get_model         (GtkIconView    *icon_view);
    120. 

  120. void           gtk_icon_view_set_text_column   (GtkIconView    *icon_view,
    121. 

  121. 	 	 			        gint            column);
    122. 

  122. gint           gtk_icon_view_get_text_column   (GtkIconView    *icon_view);
    123. 

  123. void           gtk_icon_view_set_markup_column (GtkIconView    *icon_view,
    124. 

  124. 					        gint            column);
    125. 

  125. gint           gtk_icon_view_get_markup_column (GtkIconView    *icon_view);
    126. 

  126. void           gtk_icon_view_set_pixbuf_column (GtkIconView    *icon_view,
    127. 

  127. 					        gint            column);
    128. 

  128. gint           gtk_icon_view_get_pixbuf_column (GtkIconView    *icon_view);
    129. 

  129. 

  130. void           gtk_icon_view_set_item_orientation (GtkIconView    *icon_view,
    131. 

  131.                                                    GtkOrientation  orientation);
    132. 

  132. GtkOrientation gtk_icon_view_get_item_orientation (GtkIconView    *icon_view);
    133. 

  133. void           gtk_icon_view_set_columns       (GtkIconView    *icon_view,
    134. 

  134. 		 			        gint            columns);
    135. 

  135. gint           gtk_icon_view_get_columns       (GtkIconView    *icon_view);
    136. 

  136. void           gtk_icon_view_set_item_width    (GtkIconView    *icon_view,
    137. 

  137. 					        gint            item_width);
    138. 

  138. gint           gtk_icon_view_get_item_width    (GtkIconView    *icon_view);
    139. 

  139. void           gtk_icon_view_set_spacing       (GtkIconView    *icon_view, 
    140. 

  140. 		 			        gint            spacing);
    141. 

  141. gint           gtk_icon_view_get_spacing       (GtkIconView    *icon_view);
    142. 

  142. void           gtk_icon_view_set_row_spacing   (GtkIconView    *icon_view, 
    143. 

  143. 					        gint            row_spacing);
    144. 

  144. gint           gtk_icon_view_get_row_spacing   (GtkIconView    *icon_view);
    145. 

  145. void           gtk_icon_view_set_column_spacing (GtkIconView    *icon_view, 
    146. 

  146. 					        gint            column_spacing);
    147. 

  147. gint           gtk_icon_view_get_column_spacing (GtkIconView    *icon_view);
    148. 

  148. void           gtk_icon_view_set_margin        (GtkIconView    *icon_view, 
    149. 

  149. 					        gint            margin);
    150. 

  150. gint           gtk_icon_view_get_margin        (GtkIconView    *icon_view);
    151. 

  151. void           gtk_icon_view_set_item_padding  (GtkIconView    *icon_view, 
    152. 

  152. 					        gint            item_padding);
    153. 

  153. gint           gtk_icon_view_get_item_padding  (GtkIconView    *icon_view);
    154. 

  154. 

  155. GtkTreePath *  gtk_icon_view_get_path_at_pos   (GtkIconView     *icon_view,
    156. 

  156. 						gint             x,
    157. 

  157. 						gint             y);
    158. 

  158. gboolean       gtk_icon_view_get_item_at_pos   (GtkIconView     *icon_view,
    159. 

  159. 						gint              x,
    160. 

  160. 						gint              y,
    161. 

  161. 						GtkTreePath     **path,
    162. 

  162. 						GtkCellRenderer **cell);
    163. 

  163. gboolean       gtk_icon_view_get_visible_range (GtkIconView      *icon_view,
    164. 

  164. 						GtkTreePath     **start_path,
    165. 

  165. 						GtkTreePath     **end_path);
    166. 

  166. 

  167. void           gtk_icon_view_selected_foreach   (GtkIconView            *icon_view,
    168. 

  168. 						 GtkIconViewForeachFunc  func,
    169. 

  169. 						 gpointer                data);
    170. 

  170. void           gtk_icon_view_set_selection_mode (GtkIconView            *icon_view,
    171. 

  171. 						 GtkSelectionMode        mode);
    172. 

  172. GtkSelectionMode gtk_icon_view_get_selection_mode (GtkIconView            *icon_view);
    173. 

  173. void             gtk_icon_view_select_path        (GtkIconView            *icon_view,
    174. 

  174. 						   GtkTreePath            *path);
    175. 

  175. void             gtk_icon_view_unselect_path      (GtkIconView            *icon_view,
    176. 

  176. 						   GtkTreePath            *path);
    177. 

  177. gboolean         gtk_icon_view_path_is_selected   (GtkIconView            *icon_view,
    178. 

  178. 						   GtkTreePath            *path);
    179. 

  179. gint             gtk_icon_view_get_item_row       (GtkIconView            *icon_view,
    180. 

  180.                                                    GtkTreePath            *path);
    181. 

  181. gint             gtk_icon_view_get_item_column    (GtkIconView            *icon_view,
    182. 

  182.                                                    GtkTreePath            *path);
    183. 

  183. GList           *gtk_icon_view_get_selected_items (GtkIconView            *icon_view);
    184. 

  184. void             gtk_icon_view_select_all         (GtkIconView            *icon_view);
    185. 

  185. void             gtk_icon_view_unselect_all       (GtkIconView            *icon_view);
    186. 

  186. void             gtk_icon_view_item_activated     (GtkIconView            *icon_view,
    187. 

  187. 						   GtkTreePath            *path);
    188. 

  188. void             gtk_icon_view_set_cursor         (GtkIconView            *icon_view,
    189. 

  189. 						   GtkTreePath            *path,
    190. 

  190. 						   GtkCellRenderer        *cell,
    191. 

  191. 						   gboolean                start_editing);
    192. 

  192. gboolean         gtk_icon_view_get_cursor         (GtkIconView            *icon_view,
    193. 

  193. 						   GtkTreePath           **path,
    194. 

  194. 						   GtkCellRenderer       **cell);
    195. 

  195. void             gtk_icon_view_scroll_to_path     (GtkIconView            *icon_view,
    196. 

  196.                                                    GtkTreePath            *path,
    197. 

  197. 						   gboolean                use_align,
    198. 

  198. 						   gfloat                  row_align,
    199. 

  199.                                                    gfloat                  col_align);
    200. 

  200. 

  201. /* Drag-and-Drop support */
    202. 

  202. void                   gtk_icon_view_enable_model_drag_source (GtkIconView              *icon_view,
    203. 

  203. 							       GdkModifierType           start_button_mask,
    204. 

  204. 							       const GtkTargetEntry     *targets,
    205. 

  205. 							       gint                      n_targets,
    206. 

  206. 							       GdkDragAction             actions);
    207. 

  207. void                   gtk_icon_view_enable_model_drag_dest   (GtkIconView              *icon_view,
    208. 

  208. 							       const GtkTargetEntry     *targets,
    209. 

  209. 							       gint                      n_targets,
    210. 

  210. 							       GdkDragAction             actions);
    211. 

  211. void                   gtk_icon_view_unset_model_drag_source  (GtkIconView              *icon_view);
    212. 

  212. void                   gtk_icon_view_unset_model_drag_dest    (GtkIconView              *icon_view);
    213. 

  213. void                   gtk_icon_view_set_reorderable          (GtkIconView              *icon_view,
    214. 

  214. 							       gboolean                  reorderable);
    215. 

  215. gboolean               gtk_icon_view_get_reorderable          (GtkIconView              *icon_view);
    216. 

  216. 

  217. 

  218. /* These are useful to implement your own custom stuff. */
    219. 

  219. void                   gtk_icon_view_set_drag_dest_item       (GtkIconView              *icon_view,
    220. 

  220. 							       GtkTreePath              *path,
    221. 

  221. 							       GtkIconViewDropPosition   pos);
    222. 

  222. void                   gtk_icon_view_get_drag_dest_item       (GtkIconView              *icon_view,
    223. 

  223. 							       GtkTreePath             **path,
    224. 

  224. 							       GtkIconViewDropPosition  *pos);
    225. 

  225. gboolean               gtk_icon_view_get_dest_item_at_pos     (GtkIconView              *icon_view,
    226. 

  226. 							       gint                      drag_x,
    227. 

  227. 							       gint                      drag_y,
    228. 

  228. 							       GtkTreePath             **path,
    229. 

  229. 							       GtkIconViewDropPosition  *pos);
    230. 

  230. cairo_surface_t       *gtk_icon_view_create_drag_icon         (GtkIconView              *icon_view,
    231. 

  231. 							       GtkTreePath              *path);
    232. 

  232. 

  233. void    gtk_icon_view_convert_widget_to_bin_window_coords     (GtkIconView *icon_view,
    234. 

  234.                                                                gint         wx,
    235. 

  235.                                                                gint         wy,
    236. 

  236.                                                                gint        *bx,
    237. 

  237.                                                                gint        *by);
    238. 

  238. 

  239. 

  240. void    gtk_icon_view_set_tooltip_item                        (GtkIconView     *icon_view,
    241. 

  241.                                                                GtkTooltip      *tooltip,
    242. 

  242.                                                                GtkTreePath     *path);
    243. 

  243. void    gtk_icon_view_set_tooltip_cell                        (GtkIconView     *icon_view,
    244. 

  244.                                                                GtkTooltip      *tooltip,
    245. 

  245.                                                                GtkTreePath     *path,
    246. 

  246.                                                                GtkCellRenderer *cell);
    247. 

  247. gboolean gtk_icon_view_get_tooltip_context                    (GtkIconView       *icon_view,
    248. 

  248.                                                                gint              *x,
    249. 

  249.                                                                gint              *y,
    250. 

  250.                                                                gboolean           keyboard_tip,
    251. 

  251.                                                                GtkTreeModel     **model,
    252. 

  252.                                                                GtkTreePath      **path,
    253. 

  253.                                                                GtkTreeIter       *iter);
    254. 

  254. void     gtk_icon_view_set_tooltip_column                     (GtkIconView       *icon_view,
    255. 

  255.                                                                gint               column);
    256. 

  256. gint     gtk_icon_view_get_tooltip_column                     (GtkIconView       *icon_view);
    257. 

  257. 

  258. 

  259. G_END_DECLS
    260. 

  260. 

  261. #endif /* __GTK_ICON_VIEW_H__ */
    262. 

  262.