gtk.IconView — a widget which displays a list of icons in a grid (new in PyGTK 2.6)
+-- gobject.GObject +-- gtk.Object +-- gtk.Widget +-- gtk.Container +-- gtk.IconView (implements gtk.CellLayout) |
|
|
gobject.GObject Signal Prototypes
gtk.Container Signal Prototypes
"activate-cursor-item" | def callback(iconview, user_param1, ...) |
"item-activated" | def callback(iconview, path, user_param1, ...) |
"move-cursor" | def callback(iconview, step, number, user_param1, ...) |
"select-all" | def callback(iconview, user_param1, ...) |
"select-cursor-item" | def callback(iconview, user_param1, ...) |
"selection-changed" | def callback(iconview, user_param1, ...) |
"set-scroll-adjustments" | def callback(iconview, hadj, vadj, user_param1, ...) |
"toggle-cursor-item" | def callback(iconview, user_param1, ...) |
"unselect-all" | def callback(iconview, user_param1, ...) |
This widget is available in PyGTK 2.6 and above.
The gtk.IconView widget provides an alternative view of a gtk.ListStore model. It displays the model as a grid of icons with labels. Like gtk.TreeView, you can select one or multiple items (depending on the selection mode, see the set_selection_mode() method for more information). In addition to selection with the arrow keys, gtk.IconView supports rubberband selection, which is controlled by dragging the pointer.
|
model : | A gtk.TreeModel, or None |
Returns : | a new gtk.IconView widget. |
This constructor is available in PyGTK 2.6 and above.
Creates a new gtk.IconView widget. If model is specified and not None it should specify a gtk.TreeModel to be used as the model.
|
model : | a gtk.TreeModel or None |
This method is available in PyGTK 2.6 and above.
The set_model() method sets the "model" property to the gtk.TreeModel specified by model. If model is None the old model will be unset.
|
Returns : | The gtk.TreeModel used by the cell view or None. |
This method is available in PyGTK 2.6 and above.
The get_model() method returns the value of the "model" property which contains the gtk.TreeModel used by the cell view. If no model is being used this method returns None.
|
column : | The index of a column in the model or -1 to unset the column |
This method is available in PyGTK 2.6 and above.
The set_text_column() method sets the "text-column" property to the value of column which should be the index of a column in the model containing strings to be used for text. If column is -1 the text column is unset.
|
Returns : | The index of a model's column or -1 if unset. |
This method is available in PyGTK 2.6 and above.
The get_text_column() method returns the value of the "text-column" property which contains the index of the column in the model that provides strings to be used for text. If the "text-column" property contains -1 then no column is used for text.
|
column : | The index of a column in the model or -1. |
This method is available in PyGTK 2.6 and above.
The set_markup_column() method sets the "markup-column" property to the value specified by column. The "markup-column" property indicates the index of a column in the model to be used for markup information. If column is -1 the markup column will be unset. If the markup column is set, it overrides the text column set by the set_text_column() method.
|
Returns : | the index of the model column containing markup or -1. |
This method is available in PyGTK 2.6 and above.
The get_markup_column method returns the value of the "markup-column" property which contains the index of the column in the model that contains the Pango markup for text. if the "markup-column" property is -1, the markup column is unset.
|
column : | the index of a model column or -1 |
This method is available in PyGTK 2.6 and above.
The set_pixbuf_column() method sets the "pixbuf-column" property to the value of column. If column >= 0 the icon view gtk.gdk.Pixbuf objects will be retrieved from the specified column. If column is -1 then no pixbufs will be used,
|
Returns : | The index of a column in the model or -1 |
This method is available in PyGTK 2.6 and above.
The get_pixbuf_column() returns the value of the "pixbuf-column" property which contains the index of the model column use to to retrieve gtk.gdk.Pixbuf objects to display. If the "pixbuf-column" property is -1 no pixbufs will be retrieved.
|
x : | the x coordinate |
y : | the y coordinate |
Returns : | the path at the specified point or None. |
This method is available in PyGTK 2.6 and above.
The get_path_at_pos() method returns the model path of the icon located at the coordinates specified by (x, y). This method returns None if there is no icon at the specified location.
|
x : | the x coordinate |
y : | the y coordinate |
Returns : | a 2-tuple comtaining the path and the cell renderer at the specified point or None if the is no item at the position. |
This method is available in PyGTK 2.8 and above.
The get_item_at_pos() method returns a 2-tuple containing the model path and cell renderer of the icon located at the coordinates specified by (x, y). This method returns None if there is no item at the specified location.
|
path : | a tree path |
cell : | a gtk.CellRenderer or None |
start_editing : | if TRUE the specified cell should start being edited |
This method is available in PyGTK 2.8 and above.
The set_cursor() method sets the current keyboard focus to be at the location specified by path, and selects it. This is useful when you want to focus the user's attention on a particular item. If cell is not None, then focus is given to the specified cell. Additionally, if start_editing is TRUE, then editing should be started in the specified cell.
This method is often followed by gtk.Widget.grab_focus() in order to give keyboard focus to the icon view. Please note that editing can only happen when the icon view is realized.
In PyGTK 2.8 cell and start_editing must be specified. Also cell cannot be None.
|
Returns : | a 2-tuple containing the current cursor path and cell renderer or None if the cursor isn't set. |
This method is available in PyGTK 2.8 and above.
The get_cursor() method returns a 2-tuple containing the model path and gtk.CellRenderer at the current cursor location. This method returns None if the cursor is not set. If no cell renderer has focus then None will be returned for the cell renderer value.
|
func : | a callback function or method. |
data : | User data to pass to func. |
This method is available in PyGTK 2.6 and above.
The selected_foreach() method calls the callback function or method specified by func for each selected icon. The signature of func is:
def func(iconview, path, user_data): |
where iconview is the gtk.IconView, path is the tree path of the icon row and user_data is data.
|
mode : | The selection mode. |
This method is available in PyGTK 2.6 and above.
The set_selection_mode() method sets the "selection-mode" property to the value of mode. mode should be one of the GTK Selection Mode Constants.
|
Returns : | the selection mode. |
This method is available in PyGTK 2.6 and above.
The get_selection_mode() method returns the value of the "selection-mode" property which contains one of the GTK Selection Mode Constants.
|
orientation : | the relative position of the icon and text. |
This method is available in PyGTK 2.6 and above.
The set_orientation() method sets the "orientation" property to the value of orientation. orientation should contain one of the GTK Orientation Constants. The "orientation" property indicates the relative positioning of the icon and text.
|
Returns : | the relative position of the icon and text. |
This method is available in PyGTK 2.6 and above.
The get_orientation() method returns the value of the "orientation" property that indicates the relative position between the icon and text. See the set_orientation() method for more information.
|
columns : | the number of columns in a row. |
This method is available in PyGTK 2.6 and above.
The set_columns() method sets the "columns" property to the value of columns. columns should contain the number of columns to be displayed in each row or -1 to fit as many columns as possible per row.
|
Returns : | the number of columns per row or -1. |
This method is available in PyGTK 2.6 and above.
The get_columns() method returns the value of the "columns" property that indicates the number of columns per row. See the set_columns() method for more information.
|
item_width : | The space used to display an item or -1 to use the width of the largest item. |
This method is available in PyGTK 2.6 and above.
The set_item_width() method sets the "item-width" property to the value of item_width. item_width should contain the maximum space (in pixels) to use to display an item in the icon view or -1 to use the width of the largest item.
|
Returns : | the space available for displaying an item or -1. |
This method is available in PyGTK 2.6 and above.
The get_item_width() method returns the value of the "item-width" property that contains the space available for displaying an item. See the set_item_width() method for more information.
|
spacing : | The space between the cells of an item in the icon view |
This method is available in PyGTK 2.6 and above.
The set_spacing() method sets the "spacing" property to the value of spacing. spacing should contain the space in pixels that is inserted between the cells of an item in the icon view.
|
Returns : | the space in pixels that is inserted between cells in the icon view. |
This method is available in PyGTK 2.6 and above.
The get_spacing() method returns the value of the "spacing" property that contains the space in pixels that is inserted between the cells of an item in the icon view. See the set_spacing() method for more information.
|
row_spacing : | the space between rows in the icon view. |
This method is available in PyGTK 2.6 and above.
The set_row_spacing() method sets the "row-spacing" property to the value of row_spacing. row_spacing should contain the space in pixels to be inserted between rows in the icon view..
|
Returns : | the space between rows in the icon view. |
This method is available in PyGTK 2.6 and above.
The get_row_spacing() method returns the value of the "row-spacing" property that contains the space in pixels inserted between the rows in the icon view. See the set_row_spacing() method for more information.
|
column_spacing : | The space inserted between columns in the icon view |
This method is available in PyGTK 2.6 and above.
The set_column_spacing() method sets the "column-spacing" property to the value of column_spacing. column_spacing should contain the space in pixels to be inserted between columns in the icon view.
|
Returns : | the space between columns in the icon view. |
This method is available in PyGTK 2.6 and above.
The get_column_spacing() method returns the value of the "column-spacing" property that contains the space in pixels between the columns in the icon view. See the set_column_spacing() method for more information.
|
margin : | the space inserted at the edges of the icon view. |
This method is available in PyGTK 2.6 and above.
The set_margin() method sets the "margin" property to the value of margin. margin should contain the space in pixels to be inserted at the edges of the icon view.
|
Returns : | the space inserted at the edges of the icon view. |
This method is available in PyGTK 2.6 and above.
The get_margin() method returns the value of the "margin" property that continas the space in pixels inserted at the edges of the icon view. See the set_margin() method for more information.
|
path : | a path indicating the icon to be selected |
This method is available in PyGTK 2.6 and above.
The select_path method selects the icon with the tree path specified by path.
|
path : | a path indicating the icon to be unselected |
This method is available in PyGTK 2.6 and above.
The unselect_path method unselects the icon with the tree path specified by path.
|
path : | a path of an icon. |
Returns : | TRUE if path is selected. |
This method is available in PyGTK 2.6 and above.
The path_is_selected() method returns TRUE if the icon with the tree path specified by path is selected.
|
Returns : | a list of the paths of the selected icons. |
This method is available in PyGTK 2.6 and above.
The get_selected_items() method returns a list of the paths of the selected icons.
|
This method is available in PyGTK 2.6 and above.
The select_all() method selects all the icons if the selection mode is set to gtk.SELECTION_MULTIPLE.
|
This method is available in PyGTK 2.6 and above.
The unselect_all() method unselects all the icons.
|
path : | a tree path pointing to an icon row. |
This method is available in PyGTK 2.6 and above.
The item_activated() method activates the icon pointed to by the path specified by path.
|
path : | the path of the item to move to. |
use_align : | if TRUE use the alignment arguments |
row_align : | the vertical alignment of the item specified by path. |
col_align : | The horizontal alignment of the item specified by path. |
This method is available in PyGTK 2.8 and above.
The scroll_to_path() method moves the alignments of the icon view to the position specified by path. row_align determines where the row is placed, and col_align determines where column is placed. Both are expected to be between 0.0 and 1.0. 0.0 means left/top alignment, 1.0 means right/bottom alignment, 0.5 means center.
If use_align is FALSE, then the alignment arguments are ignored, and the icon view does the minimum amount of work to scroll the item onto the screen. This means that the item will be scrolled to the edge closest to its current position. If the item is currently visible on the screen, nothing is done.
This method only works if the model is set, and path is a valid row on the model. If the model changes before the icon view is realized, the centered path will be modified to reflect this change.
|
Returns : | a 2-tuple containing the start and end paths of the visible region or None. |
This method is available in PyGTK 2.8 and above.
The get_visible_range() method returns a 2-tuple containing the start and end paths for the visible region in the iconview. If no valid paths are available this method returns None.
|
start_button_mask : | the mask of buttons allowed to start drag |
targets : | a sequence of 3-tuples containing target information that the drag will support |
actions : | the combination of possible GDK Drag Action Constants for a drag from the iconview |
This method is available in PyGTK 2.8 and above.
The enable_model_drag_source() method enables the iconview to be used as a drag source for automatic DND. start_button_mask specifies a combination of the GDK Modifier Constants that can start the drag. targets is a sequence (tuple or list) of 3-tuples each containing target information: a string representing the drag type, target flags (a combination of gtk.TARGET_SAME_APP and gtk.TARGET_SAME_WIDGET or neither) and an application assigned integer ID used for identification purposes. actions is a combination of the GDK Drag Action Constants supported by the iconview.
|
targets : | a sequence of 3-tuples containing target information that the iconview will support for a drag drop |
actions : | the combination of possible GDK Drag Action Constants for a drag drop onto to the iconview |
This method is available in PyGTK 2.8 and above.
The enable_model_drag_dest() method enables the iconview to be a destination for a drag drop. targets is a sequence (tuple or list) of 3-tuples each containing target information: a string representing the drag type, target flags (a combination of gtk.TARGET_SAME_APP and gtk.TARGET_SAME_WIDGET or neither) and an application assigned integer ID used for identification purposes. actions is a combination of the GDK Drag Action Constants supported by the iconview.
|
This method is available in PyGTK 2.8 and above.
The unset_model_drag_source() method undoes the effect of the enable_model_drag_source() method.
|
This method is available in PyGTK 2.8 and above.
The unset_model_drag_dest() method undoes the effect of the enable_model_drag_dest() method.
|
reorderable : | if TRUE the items are reorderable. |
This method is available in PyGTK 2.8 and above.
The set_reorderable() method sets the "reorderable" property to the value of reorderable. If reorderable is TRUE the user can reorder the model by dragging and dropping rows. The developer can listen to these changes by connecting to the model's "row_inserted" and "row_deleted" signals.
This method does not give you any degree of control over the order -- any reordering is allowed. If more control is needed, you should probably handle drag and drop manually.
|
Returns : | TRUE if the iconview list can be reordered. |
This method is available in PyGTK 2.8 and above.
The get_reorderable() method returns the value of the "reorderable" property. If "reorderable" is TRUE the user can reorder iconview using drag-and-drop.
|
path : | the path of the item to highlight, or None . |
pos : | specifies where to drop, relative to the item |
This method is available in PyGTK 2.8 and above.
The set_drag_dest_item() method highlights for feedback the item specified by path. pos is one of the GTK IconView Drop Position Constants that specifies where the drop is to take place relative to the receiving item.
In PyGTK 2.10 and above, path may be None.
|
Returns : | a 2-tuple containing the path of the highlighted item and one of the GTK IconView Drop Position Constants specifying the relative drop location or None. |
This method is available in PyGTK 2.8 and above.
The get_drag_dest_item() method returns a 2-tuple containing the path of the highlighted item and one of the GTK IconView Drop Position Constants specifying the drop location relative to the receiving item. If there is no highlighted item, this method returns None.
|
drag_x : | the X position |
drag_y : | the Y position |
Returns : | a 2-tuple containing the path of the highlighted item and a relative drop location. |
This method is available in PyGTK 2.8 and above.
The get_dest_item_at_pos() method returns a 2-tuple containing the path of the highlighted item at the location specified by drag_x and drag_y and the drop location relative to the receiving item. If there is no highlighted item, this method returns None.
|
path : | a path |
Returns : | a gtk.gdk.Pixmap of the drag icon. |
This method is available in PyGTK 2.8 and above.
The create_drag_icon() method returns a gtk.gdk.Pixmap representation of the item at the location specified by path. The return image can be used for a drag icon.
|
iconview : | the widget that received the signal |
user_param1 : | the first user parameter (if any) specified with the connect() method |
... : | additional user parameters (if any) |
Returns : | TRUE if the signal was handled. |
The "activate-cursor-item" signal is emitted when an icon is selected and the Enter key is pressed.
|
iconview : | the widget that received the signal |
path : | the path to the activated icon item. |
user_param1 : | the first user parameter (if any) specified with the connect() method |
... : | additional user parameters (if any) |
The "item-activated" signal is emitted when an icon item is activated by the user double clicking an icon item, pressing the Enter key when an icon item is selected or via a call to the item_activated() method.
|
iconview : | the widget that received the signal |
step : | the step size to move the cursor |
number : | the number of steps to move |
user_param1 : | the first user parameter (if any) specified with the connect() method |
... : | additional user parameters (if any) |
Returns : | TRUE if the signal was handled. |
The "move-cursor" signal is emitted when the cursor is moved using the keyboard keys: Up, Down, Control-p, Control-n, Home, End, Page_Up, Page_Down, Right, Left with various Shift and Control combinations. step will be one of the GTK Movement Step Constants.
|
iconview : | the widget that received the signal |
user_param1 : | the first user parameter (if any) specified with the connect() method |
... : | additional user parameters (if any) |
The "select-all" signal is emitted when all icon items are selected by pressing Control-a.
|
iconview : | the widget that received the signal |
user_param1 : | the first user parameter (if any) specified with the connect() method |
... : | additional user parameters (if any) |
The "select-cursor-item" signal is emitted when the icon item at the cursor is selected by the user pressing the Space key.
|
iconview : | the widget that received the signal |
user_param1 : | the first user parameter (if any) specified with the connect() method |
... : | additional user parameters (if any) |
The "selection-changed" signal is emitted when the selection is changed either by user action or program method calls.
|
iconview : | the widget that received the signal |
hadj : | the new horizontal gtk.Adjustment |
vadj : | the new vertical gtk.Adjustment |
user_param1 : | the first user parameter (if any) specified with the connect() method |
... : | additional user parameters (if any) |
The "set-scroll-adjustments" signal is emitted when the new horizontal and veritcal scroll gtk.Adjustment objects are set.
|
iconview : | the widget that received the signal |
user_param1 : | the first user parameter (if any) specified with the connect() method |
... : | additional user parameters (if any) |
The "toggle-cursor-item" signal is emitted when the user presses Control-Space.
|
iconview : | the widget that received the signal |
user_param1 : | the first user parameter (if any) specified with the connect() method |
... : | additional user parameters (if any) |
The "unselect-all" signal is emitted when the user presses Control-Shift-a.