Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members

Gnome::Vfs::Uri Class Reference

#include <uri.h>

Inheritance diagram for Gnome::Vfs::Uri:

Gnome::Vfs::TopLevelUri List of all members.

Public Member Functions

void reference () const
void unreference () const
GnomeVFSURI * gobj ()
 Provides access to the underlying C instance.

const GnomeVFSURI * gobj () const
 Provides access to the underlying C instance.

GnomeVFSURI * gobj_copy () const
Glib::RefPtr< Uriresolve_relative (const Glib::ustring &relative_reference)
 Create a new Uri from relative_reference to this object.

Glib::RefPtr< Uriappend_string (const Glib::ustring &uri_fragment)
 Create a new Uri object by appending uri_fragment to this Uri object.

Glib::RefPtr< Uriappend_path (const Glib::ustring &path)
 Create a new Uri object by appending path to this Uri object.

Glib::RefPtr< Uriappend_file_name (const Glib::ustring &filename)
 Create a new Uri object by appending filename to this Uri object.

Glib::ustring to_string (URIHideOptions hide_options=URI_HIDE_NONE) const
 Translate this Uri into a printable string.

Glib::RefPtr< Uridup ()
 Duplicate this Uri.

bool is_local () const
 Check if this Uri is a local (native) file system.

bool has_parent () const
 Check if this Uri has a parent or not.

Glib::RefPtr< Uriget_parent ()
 Retrieve this object's parent Uri.

Glib::RefPtr< const Uriget_parent () const
 Retrieve this object's parent Uri.

GnomeVFSToplevelURI * get_toplevel ()
 Retrieve the toplevel URI in uri .

Glib::ustring get_host_name () const
 Retrieve this object's host name.

Glib::ustring get_scheme () const
 Retrieve this object's scheme.

guint get_host_port () const
 Retrieve this object's host port number.

Glib::ustring get_user_name () const
 Retrieve the user name in this object.

Glib::ustring get_password () const
 Retrieve the password for this object.

void set_host_name (const Glib::ustring &host_name)
 Set host_name as the host name accessed by this Uri.

void set_host_port (guint host_port)
 Set the host port number in this Uri.

void set_user_name (const Glib::ustring &user_name)
 Set user_name as the user name for this Uri.

void set_password (const Glib::ustring &password)
 Set password as the password for this Uri.

bool is_parent (const Glib::RefPtr< const Uri > &possible_child, bool recursive=true) const
 Check if possible_child is contained by this Uri.

Glib::ustring get_path () const
 Retrieve full path name for this Uri.

Glib::ustring get_fragment_identifier () const
 Retrieve the optional fragment identifier for this Uri.

Glib::ustring extract_dirname () const
 Extract the name of the directory in which the file pointed to by this Uri is stored as a new string.

Glib::ustring extract_short_name () const
 Retrieve base file name for this Uri, ignoring any trailing path separators.

Glib::ustring extract_short_path_name () const
 Retrieve base file name for this Uri, ignoring any trailing path separators.

Glib::RefPtr< FileInfoget_file_info (FileInfoOptions options=FILE_INFO_DEFAULT) const throw (exception)
 Retrieve the file info for this Uri.

void create_symbolic_link (const Glib::ustring &target_reference) throw (exception)
 Creates a symbolic link from this Uri to target_reference.

bool uri_exists () const
 Check if this Uri points to an existing entity.


Static Public Member Functions

Glib::RefPtr< Uricreate (const Glib::ustring &uri)
 Create a new Uri from the text string uri.

Glib::ustring make_full_from_relative (const Glib::ustring &base_uri, const Glib::ustring &relative_uri)
 Returns a full Uri given a full base URI, and a secondary URI which may be relative.


Protected Member Functions

 Uri ()
void operator delete (void *, size_t)

Related Functions

(Note that these are not member functions.)

bool operator== (const Uri &lhs, const Uri &rhs)
bool operator!= (const Uri &lhs, const Uri &rhs)
Glib::RefPtr< Gnome::Vfs::Uriwrap (GnomeVFSURI *object, bool take_copy=false)

Constructor & Destructor Documentation

Gnome::Vfs::Uri::Uri  )  [protected]
 


Member Function Documentation

Glib::RefPtr<Uri> Gnome::Vfs::Uri::append_file_name const Glib::ustring filename  ) 
 

Create a new Uri object by appending filename to this Uri object.

This takes care of adding an appropriate directory separator between the end of the Uri and the start of filename if necessary.

Parameters:
filename Any "regular" file name (can include #, /, etc).
Returns:
The new Uri obtained by combining this object and filename .

Glib::RefPtr<Uri> Gnome::Vfs::Uri::append_path const Glib::ustring path  ) 
 

Create a new Uri object by appending path to this Uri object.

This takes care of adding an appropriate directory separator between the end of the Uri and the start of path if necessary.

Parameters:
path A non-escaped file path.
Returns:
The new Uri obtained by combining this object and path .

Glib::RefPtr<Uri> Gnome::Vfs::Uri::append_string const Glib::ustring uri_fragment  ) 
 

Create a new Uri object by appending uri_fragment to this Uri object.

This takes care of adding an appropriate directory separator between the end of the Uri and the start of uri_fragment if necessary.

Parameters:
uri_fragment A piece of a Uri (ie a fully escaped partial path).
Returns:
The new Uri obtained by combining this object and uri_fragment .

Glib::RefPtr<Uri> Gnome::Vfs::Uri::create const Glib::ustring uri  )  [static]
 

Create a new Uri from the text string uri.

Parameters:
uri A string representing a URI.
Returns:
The new Uri.

void Gnome::Vfs::Uri::create_symbolic_link const Glib::ustring target_reference  )  throw (exception)
 

Creates a symbolic link from this Uri to target_reference.

Parameters:
target_reference URI to point the link to (full or relative path).

Glib::RefPtr<Uri> Gnome::Vfs::Uri::dup  ) 
 

Duplicate this Uri.

Returns:
A Glib::RefPtr to a new Uri that is exactly the same as this object.

Glib::ustring Gnome::Vfs::Uri::extract_dirname  )  const
 

Extract the name of the directory in which the file pointed to by this Uri is stored as a new string.

The string will end with a GNOME_VFS_URI_PATH_CHR.

Returns:
A string representing the parent directory.

Glib::ustring Gnome::Vfs::Uri::extract_short_name  )  const
 

Retrieve base file name for this Uri, ignoring any trailing path separators.

This matches the XPG definition of basename, but not g_basename. This is often useful when you want the name of something that is pointed to by a Uri, and don't care whether the uri has a directory or file form. If this Uri points to the root of a domain, this method returns the host name; if there's no host name, returns GNOME_VFS_URI_PATH_STR.

See also: extract_short_path_name.

Returns:
A string representing the unescaped short form of the name.

Glib::ustring Gnome::Vfs::Uri::extract_short_path_name  )  const
 

Retrieve base file name for this Uri, ignoring any trailing path separators.

This matches the XPG definition of basename, but not g_basename. This is often useful when you want the name of something that is pointed to by a Uri, and don't care whether the uri has a directory or file form. If this Uri points to the root (including the root of any domain), this method returns GNOME_VFS_URI_PATH_STR.

See also: extract_short_name.

Returns:
A string representing the escaped short form of the name.

Glib::RefPtr<FileInfo> Gnome::Vfs::Uri::get_file_info FileInfoOptions  options = FILE_INFO_DEFAULT  )  const throw (exception)
 

Retrieve the file info for this Uri.

Parameters:
options An enum (bitfield) representing what information to retrieve.
Returns:
The information for this Uri.

Glib::ustring Gnome::Vfs::Uri::get_fragment_identifier  )  const
 

Retrieve the optional fragment identifier for this Uri.

Returns:
A string representing the fragment identifier for this Uri, or 0.

Glib::ustring Gnome::Vfs::Uri::get_host_name  )  const
 

Retrieve this object's host name.

Returns:
A string representing the host name.

guint Gnome::Vfs::Uri::get_host_port  )  const
 

Retrieve this object's host port number.

Returns:
The host port number used by this object. If the value is zero, the default port value for the specified toplevel access method is used.

Glib::RefPtr<const Uri> Gnome::Vfs::Uri::get_parent  )  const
 

Retrieve this object's parent Uri.

Returns:
A Glib::RefPtr to this object's parent Uri.

Glib::RefPtr<Uri> Gnome::Vfs::Uri::get_parent  ) 
 

Retrieve this object's parent Uri.

Returns:
A Glib::RefPtr to this object's parent Uri.

Glib::ustring Gnome::Vfs::Uri::get_password  )  const
 

Retrieve the password for this object.

Returns:
The password for this Uri.

Glib::ustring Gnome::Vfs::Uri::get_path  )  const
 

Retrieve full path name for this Uri.

Returns:
A string representing the full path of this object.

Glib::ustring Gnome::Vfs::Uri::get_scheme  )  const
 

Retrieve this object's scheme.

Returns:
A string representing the scheme.

GnomeVFSToplevelURI* Gnome::Vfs::Uri::get_toplevel  ) 
 

Retrieve the toplevel URI in uri .

Returns:
A pointer to the toplevel URI object.

Glib::ustring Gnome::Vfs::Uri::get_user_name  )  const
 

Retrieve the user name in this object.

Returns:
A string representing the user name in this Uri.

const GnomeVFSURI* Gnome::Vfs::Uri::gobj  )  const
 

Provides access to the underlying C instance.

GnomeVFSURI* Gnome::Vfs::Uri::gobj  ) 
 

Provides access to the underlying C instance.

GnomeVFSURI* Gnome::Vfs::Uri::gobj_copy  )  const
 

bool Gnome::Vfs::Uri::has_parent  )  const
 

Check if this Uri has a parent or not.

Returns:
true if this Uri has a parent, false otherwise.

bool Gnome::Vfs::Uri::is_local  )  const
 

Check if this Uri is a local (native) file system.

Returns:
false if uri is not a local file system, true otherwise.

bool Gnome::Vfs::Uri::is_parent const Glib::RefPtr< const Uri > &  possible_child,
bool  recursive = true
const
 

Check if possible_child is contained by this Uri.

If recursive is false, just try the immediate parent directory, else search up through the hierarchy.

Parameters:
possible_child A Glib::RefPtr to the Uri to test.
recursive A flag to turn recursive check on.
Returns:
true if possible_child is contained in this Uri.

Glib::ustring Gnome::Vfs::Uri::make_full_from_relative const Glib::ustring base_uri,
const Glib::ustring relative_uri
[static]
 

Returns a full Uri given a full base URI, and a secondary URI which may be relative.

Parameters:
base_uri A string representing the base URI.
relative_uri A URI fragment/reference to be appended to base_uri .
Returns:
A string containing the URI (0 for some bad errors).

void Gnome::Vfs::Uri::operator delete void *  ,
size_t 
[protected]
 

void Gnome::Vfs::Uri::reference  )  const
 

Glib::RefPtr<Uri> Gnome::Vfs::Uri::resolve_relative const Glib::ustring relative_reference  ) 
 

Create a new Uri from relative_reference to this object.

Parameters:
relative_reference A string representing a possibly relative URI reference.
Returns:
The new Uri.

void Gnome::Vfs::Uri::set_host_name const Glib::ustring host_name  ) 
 

Set host_name as the host name accessed by this Uri.

Parameters:
host_name A string representing a host name.

void Gnome::Vfs::Uri::set_host_port guint  host_port  ) 
 

Set the host port number in this Uri.

If host_port is zero, the default port for this object's toplevel access method is used.

Parameters:
host_port A TCP/IP port number.

void Gnome::Vfs::Uri::set_password const Glib::ustring password  ) 
 

Set password as the password for this Uri.

Parameters:
password A password string.

void Gnome::Vfs::Uri::set_user_name const Glib::ustring user_name  ) 
 

Set user_name as the user name for this Uri.

Parameters:
user_name A string representing a user name on the host accessed by this object.

Glib::ustring Gnome::Vfs::Uri::to_string URIHideOptions  hide_options = URI_HIDE_NONE  )  const
 

Translate this Uri into a printable string.

The string will not contain the Uri elements specified by hide_options .

Parameters:
hide_options Bitmask specifying what URI elements (e.g. password, user name etc.) should NOT be represented in the returned string.
Returns:
A Glib::ustring representing this Uri.

void Gnome::Vfs::Uri::unreference  )  const
 

bool Gnome::Vfs::Uri::uri_exists  )  const
 

Check if this Uri points to an existing entity.

Returns:
true if this Uri exists.


Friends And Related Function Documentation

bool operator!= const Uri lhs,
const Uri rhs
[related]
 

bool operator== const Uri lhs,
const Uri rhs
[related]
 

Glib::RefPtr< Gnome::Vfs::Uri > wrap GnomeVFSURI *  object,
bool  take_copy = false
[related]
 


The documentation for this class was generated from the following file:
Generated on Mon Apr 5 17:43:42 2004 for libgnomevfsmm by doxygen 1.3.6-20040222