Hildon::FileSystemModel Class Reference

#include <file-system-model.h>

Inheritance diagram for Hildon::FileSystemModel:

List of all members.

Public Member Functions
virtual	~FileSystemModel ()
HildonFileSystemModel *	gobj ()
	Provides access to the underlying C GObject.
const HildonFileSystemModel *	gobj () const
	Provides access to the underlying C GObject.
HildonFileSystemModel *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
	FileSystemModel ()
Gtk::TreeModel::iterator	search_local_path (const Glib::ustring &path, bool recursive=true) const
Gtk::TreeModel::iterator	search_local_path (const Glib::ustring &path, const Gtk::TreeModel::iterator &start_iter, bool recursive=true) const
Gtk::TreeModel::iterator	search_uri (const Glib::ustring &uri, bool recursive=true) const
Gtk::TreeModel::iterator	search_uri (const Glib::ustring &uri, const Gtk::TreeModel::iterator &start_iter, bool recursive=true) const
Gtk::TreeModel::iterator	search_path (const GtkFilePath *path, bool recursive=true) const
Gtk::TreeModel::iterator	search_path (const GtkFilePath *path, const Gtk::TreeModel::iterator &start_iter, bool recursive=true) const
Gtk::TreeModel::iterator	load_local_path (const Glib::ustring &path)
Gtk::TreeModel::iterator	load_uri (const Glib::ustring &uri)
Gtk::TreeModel::iterator	load_path (const GtkFilePath *path)
Glib::ustring	new_item (const Gtk::TreeModel::iterator &parent, const Glib::ustring &stub_name, const Glib::ustring &extension)
	Creates a new unique name under parent.
Glib::ustring	autoname_uri (const Glib::ustring &uri, std::auto_ptr< Glib::Error > &error)
	This function checks if the given URI already exists in the model.
void	iter_available (const Gtk::TreeModel::iterator &iter, bool available)
	This function sets some paths available/not available.
void	reset_available ()
	Cancels all changes made by hildon_file_system_model_iter_available.
Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Hildon::FileSystemModel >	wrap (HildonFileSystemModel *object, bool take_copy=false)

---

Constructor & Destructor Documentation

virtual Hildon::FileSystemModel::~FileSystemModel (   )  [virtual]

Hildon::FileSystemModel::FileSystemModel (   )

---

Member Function Documentation

Glib::ustring Hildon::FileSystemModel::autoname_uri (  const Glib::ustring &  uri, std::auto_ptr< Glib::Error > &  error )

This function checks if the given URI already exists in the model. if not, then a copy of it is returned unmodified. If the URI already exists then a number is added in a form file://file(2).html. Parameters: uri  An URI to be autonamed. error  A GError to hold possible error information. Returns: Either the same uri given as parameter or a modified uri that contains proper index number. In both cases free this value using g_free. Value can be 0, if error was encountered.

const HildonFileSystemModel* Hildon::FileSystemModel::gobj (   )  const [inline]

Provides access to the underlying C GObject.

HildonFileSystemModel* Hildon::FileSystemModel::gobj (   )  [inline]

Provides access to the underlying C GObject.

HildonFileSystemModel* Hildon::FileSystemModel::gobj_copy (   )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

void Hildon::FileSystemModel::iter_available (  const Gtk::TreeModel::iterator &  iter, bool  available )

This function sets some paths available/not available. Locations that are not available are usually shown dimmed in the gui. This function can be used if program needs for some reason to disable some locations. By default all paths are available. Parameters: iter  A Gtk::TreeIter to location to modify. available  New availability state.

Gtk::TreeModel::iterator Hildon::FileSystemModel::load_local_path (  const Glib::ustring &  path  )

Gtk::TreeModel::iterator Hildon::FileSystemModel::load_path (  const GtkFilePath *  path  )

Gtk::TreeModel::iterator Hildon::FileSystemModel::load_uri (  const Glib::ustring &  uri  )

Glib::ustring Hildon::FileSystemModel::new_item (  const Gtk::TreeModel::iterator &  parent, const Glib::ustring &  stub_name, const Glib::ustring &  extension )

Creates a new unique name under parent. The returned name can be used when creating a new file. If there are no name collisions, stub name will be the final name. If a file with that name already exists, then a number is appended to stub. This function is mainly used by dialog implementations. It's probably not needed in application development. Parameters: parent  A parent iterator. stub_name  A boby of the new name. extension  Extension of the new name. Returns: A New unique name. You have to release this with g_free. Can be 0, if the directory is not yet loaded.

void Hildon::FileSystemModel::reset_available (   )

Cancels all changes made by hildon_file_system_model_iter_available. Selection is back to it's default state.

Gtk::TreeModel::iterator Hildon::FileSystemModel::search_local_path (  const Glib::ustring &  path, const Gtk::TreeModel::iterator &  start_iter, bool  recursive = true )  const

Gtk::TreeModel::iterator Hildon::FileSystemModel::search_local_path (  const Glib::ustring &  path, bool  recursive = true )  const

Gtk::TreeModel::iterator Hildon::FileSystemModel::search_path (  const GtkFilePath *  path, const Gtk::TreeModel::iterator &  start_iter, bool  recursive = true )  const

Gtk::TreeModel::iterator Hildon::FileSystemModel::search_path (  const GtkFilePath *  path, bool  recursive = true )  const

Gtk::TreeModel::iterator Hildon::FileSystemModel::search_uri (  const Glib::ustring &  uri, const Gtk::TreeModel::iterator &  start_iter, bool  recursive = true )  const

Gtk::TreeModel::iterator Hildon::FileSystemModel::search_uri (  const Glib::ustring &  uri, bool  recursive = true )  const

---

Friends And Related Function Documentation

Glib::RefPtr< Hildon::FileSystemModel > wrap (  HildonFileSystemModel *  object, bool  take_copy = false )  [related]

Parameters: object  The C instance 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:

• file-system-model.h

---