Gnome::Vfs::MimeApplication Class Reference

#include <mime-application.h>

List of all members.

Public Member Functions

 MimeApplication ()
 MimeApplication (GnomeVFSMimeApplication *castitem, bool make_a_copy=false)
 MimeApplication (const MimeApplication &src)
MimeApplicationoperator= (const MimeApplication &src)
 ~MimeApplication ()
GnomeVFSMimeApplication * gobj ()
const GnomeVFSMimeApplication * gobj () const
GnomeVFSMimeApplication * gobj_copy () const
 Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
 MimeApplication (const Glib::ustring &id)
 MimeApplication (const Glib::ustring &id, const Glib::ustring &name, const Glib::ustring &command, MimeApplicationArgumentType argument_type, ListHandleStrings supported_uri_schemes, bool multiple_files, bool requires_terminal)
 operator bool () const
Glib::ustring get_id () const
 Get the id of this applicaiton.
Glib::ustring get_name () const
 Get the name of this application.
Glib::ustring get_command () const
 Get the command for this application.
MimeApplicationArgumentType get_argument_type () const
 Get the argument type for this application.
Glib::ListHandle< Glib::ustring > get_supported_uri_schemes () const
 Get a list of this application's supported uri schemes.
bool can_open_multiple_files () const
 Test to see if this application can open multiple files.
bool requires_terminal () const
 Test to see if this application requires the terminal.
void set_id (const Glib::ustring &value)
void set_name (const Glib::ustring &value)
void set_command (const Glib::ustring &value)
void set_argument_type (const MimeApplicationArgumentType &value)
void set_supported_uri_schemes (const Glib::ListHandle< Glib::ustring > &value)
void set_open_multiple_files (bool value=true)
void set_requires_terminal (bool value=true)
bool is_user_owned () const
 Checks whether this application is owned or not.
bool exists_in_registry () const
void remove_from_registry ()
void save_to_registry ()
 This will save to the registry the application that will be associated with a defined mime type.
ListHandleStrings get_keys () const
ListHandleStrings get_mime_types () const
void clear_mime_types ()
bool supports_mime_type (const Glib::ustring &mime_type) const
bool supports_uri_scheme (const Glib::ustring &uri_scheme) const
Glib::ustring get_value (const Glib::ustring &key) const
bool get_value_bool (const Glib::ustring &key, bool &got_key) const
bool get_value_bool (const Glib::ustring &key) const
void set_value (const Glib::ustring &key, const Glib::ustring &value)
void set_value (const Glib::ustring &key, bool value)
void unset_key (const Glib::ustring &key)
void add_mime_type (const Glib::ustring &mime_type)
void remove_mime_type (const Glib::ustring &mime_type)
void set_default (const Glib::ustring &mime_type) throw (exception)
void add_to_short_list (const Glib::ustring &mime_type) throw (exception)
void remove_from_short_list (const Glib::ustring &mime_type) throw (exception)
void launch (const Glib::ListHandle< Glib::ustring > &uris) throw (exception)
void launch (const Glib::ListHandle< Glib::ustring > &uris, const Glib::ustring &envp) throw (exception)

Protected Attributes

GnomeVFSMimeApplication * gobject_

Related Functions

(Note that these are not member functions.)

Gnome::Vfs::MimeApplication wrap (GnomeVFSMimeApplication *object, bool take_copy=false)


Constructor & Destructor Documentation

Gnome::Vfs::MimeApplication::MimeApplication (  ) 

Gnome::Vfs::MimeApplication::MimeApplication ( GnomeVFSMimeApplication *  castitem,
bool  make_a_copy = false 
) [explicit]

Gnome::Vfs::MimeApplication::MimeApplication ( const MimeApplication src  ) 

Gnome::Vfs::MimeApplication::~MimeApplication (  ) 

Gnome::Vfs::MimeApplication::MimeApplication ( const Glib::ustring &  id  ) 

Gnome::Vfs::MimeApplication::MimeApplication ( const Glib::ustring &  id,
const Glib::ustring &  name,
const Glib::ustring &  command,
MimeApplicationArgumentType  argument_type,
ListHandleStrings  supported_uri_schemes,
bool  multiple_files,
bool  requires_terminal 
)


Member Function Documentation

void Gnome::Vfs::MimeApplication::add_mime_type ( const Glib::ustring &  mime_type  ) 

void Gnome::Vfs::MimeApplication::add_to_short_list ( const Glib::ustring &  mime_type  )  throw (exception)

bool Gnome::Vfs::MimeApplication::can_open_multiple_files (  )  const

Test to see if this application can open multiple files.

Returns:
true if this application has this ability; false otherwise.

void Gnome::Vfs::MimeApplication::clear_mime_types (  ) 

bool Gnome::Vfs::MimeApplication::exists_in_registry (  )  const

MimeApplicationArgumentType Gnome::Vfs::MimeApplication::get_argument_type (  )  const

Get the argument type for this application.

Returns:
An enum representing this application's argument type.

Glib::ustring Gnome::Vfs::MimeApplication::get_command (  )  const

Get the command for this application.

Returns:
A string containing this application's command.

Glib::ustring Gnome::Vfs::MimeApplication::get_id (  )  const

Get the id of this applicaiton.

Returns:
A string containing this application's id.

ListHandleStrings Gnome::Vfs::MimeApplication::get_keys (  )  const

ListHandleStrings Gnome::Vfs::MimeApplication::get_mime_types (  )  const

Glib::ustring Gnome::Vfs::MimeApplication::get_name (  )  const

Get the name of this application.

Returns:
A string containing this application's name.

Glib::ListHandle<Glib::ustring> Gnome::Vfs::MimeApplication::get_supported_uri_schemes (  )  const

Get a list of this application's supported uri schemes.

Returns:
A list of strings containing the uri schemes.

Glib::ustring Gnome::Vfs::MimeApplication::get_value ( const Glib::ustring &  key  )  const

bool Gnome::Vfs::MimeApplication::get_value_bool ( const Glib::ustring &  key  )  const

bool Gnome::Vfs::MimeApplication::get_value_bool ( const Glib::ustring &  key,
bool &  got_key 
) const

const GnomeVFSMimeApplication* Gnome::Vfs::MimeApplication::gobj (  )  const [inline]

GnomeVFSMimeApplication* Gnome::Vfs::MimeApplication::gobj (  )  [inline]

GnomeVFSMimeApplication* Gnome::Vfs::MimeApplication::gobj_copy (  )  const

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

bool Gnome::Vfs::MimeApplication::is_user_owned (  )  const

Checks whether this application is owned or not.

By user owned, this means that the application is not a system application located in the prerequisite /usr area, but rather in the user's area.

Parameters:
application C++ doesn't use this :).
Returns:
true if this application is user owned, otherwise false.

void Gnome::Vfs::MimeApplication::launch ( const Glib::ListHandle< Glib::ustring > &  uris,
const Glib::ustring &  envp 
) throw (exception)

void Gnome::Vfs::MimeApplication::launch ( const Glib::ListHandle< Glib::ustring > &  uris  )  throw (exception)

Gnome::Vfs::MimeApplication::operator bool (  )  const

MimeApplication& Gnome::Vfs::MimeApplication::operator= ( const MimeApplication src  ) 

void Gnome::Vfs::MimeApplication::remove_from_registry (  ) 

void Gnome::Vfs::MimeApplication::remove_from_short_list ( const Glib::ustring &  mime_type  )  throw (exception)

void Gnome::Vfs::MimeApplication::remove_mime_type ( const Glib::ustring &  mime_type  ) 

bool Gnome::Vfs::MimeApplication::requires_terminal (  )  const

Test to see if this application requires the terminal.

Returns:
true if this application needs the terminal; false otherwise.

void Gnome::Vfs::MimeApplication::save_to_registry (  ) 

This will save to the registry the application that will be associated with a defined mime type.

The defined mime type is located within the GnomeVFSMimeApplication structure. Changes are not realized until the gnome_vfs_application_registry_sync function is called.

Parameters:
application Application associated with the mime type.

void Gnome::Vfs::MimeApplication::set_argument_type ( const MimeApplicationArgumentType value  ) 

void Gnome::Vfs::MimeApplication::set_command ( const Glib::ustring &  value  ) 

void Gnome::Vfs::MimeApplication::set_default ( const Glib::ustring &  mime_type  )  throw (exception)

void Gnome::Vfs::MimeApplication::set_id ( const Glib::ustring &  value  ) 

void Gnome::Vfs::MimeApplication::set_name ( const Glib::ustring &  value  ) 

void Gnome::Vfs::MimeApplication::set_open_multiple_files ( bool  value = true  ) 

void Gnome::Vfs::MimeApplication::set_requires_terminal ( bool  value = true  ) 

void Gnome::Vfs::MimeApplication::set_supported_uri_schemes ( const Glib::ListHandle< Glib::ustring > &  value  ) 

void Gnome::Vfs::MimeApplication::set_value ( const Glib::ustring &  key,
bool  value 
)

void Gnome::Vfs::MimeApplication::set_value ( const Glib::ustring &  key,
const Glib::ustring &  value 
)

bool Gnome::Vfs::MimeApplication::supports_mime_type ( const Glib::ustring &  mime_type  )  const

bool Gnome::Vfs::MimeApplication::supports_uri_scheme ( const Glib::ustring &  uri_scheme  )  const

void Gnome::Vfs::MimeApplication::unset_key ( const Glib::ustring &  key  ) 


Friends And Related Function Documentation

Gnome::Vfs::MimeApplication wrap ( GnomeVFSMimeApplication *  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.


Member Data Documentation

GnomeVFSMimeApplication* Gnome::Vfs::MimeApplication::gobject_ [protected]


The documentation for this class was generated from the following file:
Generated on Tue Aug 22 09:07:08 2006 for libgnomevfsmm by  doxygen 1.4.7