logo top
Main Page   Widgets   Namespaces   Book  

Gtk::IconView Class Reference
[WidgetsContainer Widgets]

Inheritance diagram for Gtk::IconView:

Inheritance graph
[legend]
List of all members.

Detailed Description

TODO.


Public Types

typedef Glib::ListHandle<
TreePath, TreePathTraits > 
ArrayHandle_TreePaths
typedef sigc::slot< void,
const TreeModel::Path& > 
SlotForeach
 For instance, void on_foreach(const Gtk::TreeModel::Path& path);.

Public Member Functions

int get_column_spacing () const
int get_columns () const
int get_icon_width () const
int get_margin () const
int get_markup_column () const
 Returns the column with markup text for icon_view .
Glib::RefPtr<const TreeModelget_model () const
 Returns the model the Gtk::IconView is based on.
Glib::RefPtr<TreeModelget_model ()
 Returns the model the Gtk::IconView is based on.
Orientation get_orientation () const
 Returns the value of the orientation property which determines whether the labels are drawn beside the icons instead of below.
TreeModel::Path get_path_at_pos (int x, int y) const
 Finds the path at the point ( x , y ), relative to widget coordinates.
int get_pixbuf_column () const
 Returns the column with pixbufs for icon_view .
gint get_row_spacing () const
ArrayHandle_TreePaths get_selected_items () const
 Creates a list of paths of all selected items.
SelectionMode get_selection_mode () const
 Gets the selection mode of the icon_view .
int get_spacing () const
int get_text_column () const
 Returns the column with text for icon_view .
const GtkIconView* gobj () const
 Provides access to the underlying C GtkObject.
GtkIconView* gobj ()
 Provides access to the underlying C GtkObject.
 IconView (const Glib::RefPtr<TreeModel>& model)
 IconView ()
void item_activated (const TreeModel::Path& path)
 Activates the item determined by path .
bool path_is_selected (const TreeModel::Path& path) const
 Returns true if the icon pointed to by path is currently selected.
void select_all ()
 Selects all the icons.
void select_path (const TreeModel::Path& path)
 Selects the row at path .
void selected_foreach (const SlotForeach& slot)
 Calls a function for each selected icon.
void set_column_spacing (int column_spacing)
void set_columns (int columns)
void set_item_width (int item_width)
void set_margin (int margin)
void set_markup_column (const TreeModelColumnBase& column)
 Sets the column with markup information for icon_view to be column .
void set_markup_column (int column)
 Sets the column with markup information for icon_view to be column .
void set_model (const Glib::RefPtr<TreeModel>& model)
 Sets the model for a Gtk::IconView.
void set_orientation (Orientation orientation)
 Sets the orientation property which determines whether the labels are drawn beside the icons instead of below.
void set_pixbuf_column (const TreeModelColumnBase& column)
 Sets the column with pixbufs for icon_view to be column .
void set_pixbuf_column (int column)
 Sets the column with pixbufs for icon_view to be column .
void set_row_spacing (int row_spacing)
void set_selection_mode (SelectionMode mode)
 Sets the selection mode of the icon_view .
void set_spacing (int spacing)
void set_text_column (const TreeModelColumnBase& model_column)
 Sets the column with text for icon_view to be column .
void set_text_column (int column)
 Sets the column with text for icon_view to be column .
Glib::SignalProxy1< void,
const TreeModel::Path& > 
signal_item_activated ()
 
Prototype:
void item_activated(const TreeModel::Path& path)

Glib::SignalProxy0<void> signal_selection_changed ()
 
Prototype:
void selection_changed()

Glib::SignalProxy2< void,
Adjustment*, Adjustment* > 
signal_set_scroll_adjustments ()
 
Prototype:
void set_scroll_adjustments(Adjustment* hadjustment, Adjustment* vadjustment)

void unselect_all ()
 Unselects all the icons.
void unselect_path (const TreeModel::Path& path)
 Unselects the row at path .
virtual ~IconView ()

Related Functions

(Note that these are not member functions.)

Gtk::IconViewwrap (GtkIconView* object, bool take_copy=false)
 
Parameters:
object The C instance


Member Typedef Documentation

typedef Glib::ListHandle<TreePath, TreePathTraits> Gtk::IconView::ArrayHandle_TreePaths

typedef sigc::slot<void, const TreeModel::Path&> Gtk::IconView::SlotForeach

For instance, void on_foreach(const Gtk::TreeModel::Path& path);.


Constructor & Destructor Documentation

virtual Gtk::IconView::~IconView (  )  [virtual]

Gtk::IconView::IconView (  ) 

Gtk::IconView::IconView ( const Glib::RefPtr<TreeModel>&  model  )  [explicit]


Member Function Documentation

int Gtk::IconView::get_column_spacing (  )  const

int Gtk::IconView::get_columns (  )  const

int Gtk::IconView::get_icon_width (  )  const

int Gtk::IconView::get_margin (  )  const

int Gtk::IconView::get_markup_column (  )  const

Returns the column with markup text for icon_view .

Returns:
The markup column, or -1 if it's unset.
.

Glib::RefPtr<const TreeModel> Gtk::IconView::get_model (  )  const

Returns the model the Gtk::IconView is based on.

Returns 0 if the model is unset.

Returns:
A Gtk::TreeModel, or 0 if none is currently being used.
.

Glib::RefPtr<TreeModel> Gtk::IconView::get_model (  ) 

Returns the model the Gtk::IconView is based on.

Returns 0 if the model is unset.

Returns:
A Gtk::TreeModel, or 0 if none is currently being used.
.

Orientation Gtk::IconView::get_orientation (  )  const

Returns the value of the orientation property which determines whether the labels are drawn beside the icons instead of below.

Returns:
The relative position of texts and icons
.

TreeModel::Path Gtk::IconView::get_path_at_pos ( int  x,
int  y 
) const

Finds the path at the point ( x , y ), relative to widget coordinates.

Parameters:
x The x position to be identified.
y The y position to be identified.
Returns:
The Gtk::TreePath corresponding to the icon or 0 if no icon exists at that position.
.

int Gtk::IconView::get_pixbuf_column (  )  const

Returns the column with pixbufs for icon_view .

Returns:
The pixbuf column, or -1 if it's unset.
.

gint Gtk::IconView::get_row_spacing (  )  const

ArrayHandle_TreePaths Gtk::IconView::get_selected_items (  )  const

Creates a list of paths of all selected items.

Additionally, if you are planning on modifying the model after calling this function, you may want to convert the returned list into a list of Gtk::TreeRowReference<!-- -->s. To do this, you can use Gtk::Tree::row_reference_new().

To free the return value, use:

 g_list_foreach (list, gtk_tree_path_free, <tt>0</tt>);
 g_list_free (list);
Returns:
A G::List containing a Gtk::TreePath for each selected row.
.

SelectionMode Gtk::IconView::get_selection_mode (  )  const

Gets the selection mode of the icon_view .

Returns:
The current selection mode
.

int Gtk::IconView::get_spacing (  )  const

int Gtk::IconView::get_text_column (  )  const

Returns the column with text for icon_view .

Returns:
The text column, or -1 if it's unset.
.

const GtkIconView* Gtk::IconView::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Container.

GtkIconView* Gtk::IconView::gobj (  )  [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Container.

void Gtk::IconView::item_activated ( const TreeModel::Path path  ) 

Activates the item determined by path .

Parameters:
path The Gtk::TreePath to be activated.

bool Gtk::IconView::path_is_selected ( const TreeModel::Path path  )  const

Returns true if the icon pointed to by path is currently selected.

If icon does not point to a valid location, false is returned.

Parameters:
path A Gtk::TreePath to check selection on.
Returns:
true if path is selected.
.

void Gtk::IconView::select_all (  ) 

Selects all the icons.

icon_view must has its selection mode set to Gtk::SELECTION_MULTIPLE.

void Gtk::IconView::select_path ( const TreeModel::Path path  ) 

Selects the row at path .

Parameters:
path The Gtk::TreePath to be selected.

void Gtk::IconView::selected_foreach ( const SlotForeach slot  ) 

Calls a function for each selected icon.

Note that the model or selection cannot be modified from within this function.

Parameters:
slot The callback to call for each selected icon.

void Gtk::IconView::set_column_spacing ( int  column_spacing  ) 

void Gtk::IconView::set_columns ( int  columns  ) 

void Gtk::IconView::set_item_width ( int  item_width  ) 

void Gtk::IconView::set_margin ( int  margin  ) 

void Gtk::IconView::set_markup_column ( const TreeModelColumnBase column  ) 

Sets the column with markup information for icon_view to be column .

The markup column must be of type G::TYPE_STRING. If the markup column is set to something, it overrides the text column set by set_text_column().

Parameters:
column A column in the currently used model.

void Gtk::IconView::set_markup_column ( int  column  ) 

Sets the column with markup information for icon_view to be column .

The markup column must be of type G::TYPE_STRING. If the markup column is set to something, it overrides the text column set by set_text_column().

Parameters:
column A column in the currently used model.

void Gtk::IconView::set_model ( const Glib::RefPtr<TreeModel>&  model  ) 

Sets the model for a Gtk::IconView.

If the icon_view already has a model set, it will remove it before setting the new model. If model is 0, then it will unset the old model.

Parameters:
model The model.

void Gtk::IconView::set_orientation ( Orientation  orientation  ) 

Sets the orientation property which determines whether the labels are drawn beside the icons instead of below.

Parameters:
orientation The relative position of texts and icons.

void Gtk::IconView::set_pixbuf_column ( const TreeModelColumnBase column  ) 

Sets the column with pixbufs for icon_view to be column .

The pixbuf column must be of type Gdk::TYPE_PIXBUF

Parameters:
column A column in the currently used model.

void Gtk::IconView::set_pixbuf_column ( int  column  ) 

Sets the column with pixbufs for icon_view to be column .

The pixbuf column must be of type Gdk::TYPE_PIXBUF

Parameters:
column A column in the currently used model.

void Gtk::IconView::set_row_spacing ( int  row_spacing  ) 

void Gtk::IconView::set_selection_mode ( SelectionMode  mode  ) 

Sets the selection mode of the icon_view .

Parameters:
mode The selection mode.

void Gtk::IconView::set_spacing ( int  spacing  ) 

void Gtk::IconView::set_text_column ( const TreeModelColumnBase model_column  ) 

Sets the column with text for icon_view to be column .

The text column must be of type G::TYPE_STRING.

Parameters:
column A column in the currently used model.

void Gtk::IconView::set_text_column ( int  column  ) 

Sets the column with text for icon_view to be column .

The text column must be of type G::TYPE_STRING.

Parameters:
column A column in the currently used model.

Glib::SignalProxy1<void,const TreeModel::Path&> Gtk::IconView::signal_item_activated (  ) 

Prototype:
void item_activated(const TreeModel::Path& path)

Glib::SignalProxy0< void > Gtk::IconView::signal_selection_changed (  ) 

Prototype:
void selection_changed()

Glib::SignalProxy2<void,Adjustment*,Adjustment*> Gtk::IconView::signal_set_scroll_adjustments (  ) 

Prototype:
void set_scroll_adjustments(Adjustment* hadjustment, Adjustment* vadjustment)

void Gtk::IconView::unselect_all (  ) 

Unselects all the icons.

void Gtk::IconView::unselect_path ( const TreeModel::Path path  ) 

Unselects the row at path .

Parameters:
path The Gtk::TreePath to be unselected.


Friends And Related Function Documentation

Gtk::IconView* wrap ( GtkIconView *  object,
bool  take_copy = false 
) [related]

Parameters:
object The C instance

Parameters:
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.


The documentation for this class was generated from the following file:
Generated for gtkmm 2.4 by Doxygen 1.5.1 © 1997-2001