libgnomevfsmm  2.26.0
Public Types | Public Member Functions | Protected Attributes | List of all members
Gnome::Vfs::Async2::Handle Class Reference

#include <async-handle-2.h>

Public Types

enum  Priority { PRIORITY_DEFAULT = 0, PRIORITY_MIN = -10, PRIORITY_MAX = 10 }
 Possible pre-set values for a job's priority. More...
 
typedef sigc::slot< void,
const Async2::Handle &, Result
SlotOpen
 
typedef SlotOpen SlotClose
 
typedef sigc::slot< void,
const Async2::Handle &, const
Glib::RefPtr< Glib::IOChannel >
&, Result
SlotOpenAsChannel
 
typedef SlotOpenAsChannel SlotCreateAsChannel
 
typedef sigc::slot< void,
const Async2::Handle &, Result,
gpointer, FileSize, FileSize
SlotRead
 
typedef sigc::slot< void,
const Async2::Handle &, Result,
gconstpointer, FileSize,
FileSize
SlotWrite
 
typedef sigc::slot< void,
const Async2::Handle
&, ListHandleFileInfoResults
SlotGetFileInfo
 
typedef sigc::slot< void,
const Async2::Handle &, Result,
const Glib::RefPtr< FileInfo > & > 
SlotSetFileInfo
 
typedef sigc::slot< void,
const Async2::Handle &, Result,
Glib::ListHandle< Glib::RefPtr
< FileInfo > >, int > 
SlotLoadDirectory
 
typedef sigc::slot< int, const
Async2::Handle
&, Transfer2::ProgressInfo & > 
SlotTransferProgress
 
typedef sigc::slot< void,
const Async2::Handle
&, ListHandleFindDirectoryResult
SlotFindDirectory
 
typedef sigc::slot< void,
const Async2::Handle &, Result,
gpointer > 
SlotFileControl
 

Public Member Functions

 Handle ()
 
 ~Handle ()
 
void open (const Glib::ustring &text_uri, OpenMode open_mode, int priority, const SlotOpen &slot)
 
void open (const Glib::RefPtr< Uri > &uri, OpenMode open_mode, int priority, const SlotOpen &slot)
 
void open_as_channel (const Glib::ustring &text_uri, OpenMode open_mode, guint advised_block_size, int priority, const SlotOpenAsChannel &slot)
 
void open_as_channel (const Glib::RefPtr< Uri > &uri, OpenMode open_mode, guint advised_block_size, int priority, const SlotOpenAsChannel &slot)
 
void create (const Glib::ustring &text_uri, OpenMode open_mode, bool exclusive, guint perm, int priority, const SlotOpen &slot)
 
void create (const Glib::RefPtr< Uri > &uri, OpenMode open_mode, bool exclusive, guint perm, int priority, const SlotOpen &slot)
 
void create_symbolic_link (const Glib::RefPtr< Uri > &uri, const Glib::ustring &uri_reference, int priority, const SlotOpen &slot)
 
void create_as_channel (const Glib::ustring &text_uri, OpenMode open_mode, bool exclusive, guint perm, int priority, const SlotCreateAsChannel &slot)
 
void close (const SlotClose &slot)
 
void read (gpointer buffer, guint bytes, const SlotRead &slot)
 
void write (gconstpointer buffer, guint bytes, const SlotWrite &slot)
 
void get_file_info (const ListHandleUris &uri_list, FileInfoOptions options, int priority, const SlotGetFileInfo &slot) const
 
void set_file_info (const Glib::RefPtr< Uri > &uri, const Glib::RefPtr< FileInfo > &info, SetFileInfoMask mask, FileInfoOptions options, int priority, const SlotSetFileInfo &slot)
 
void load_directory (const Glib::ustring &text_uri, FileInfoOptions options, guint items_per_notification, int priority, const SlotLoadDirectory &slot)
 
void load_directory (const Glib::RefPtr< Uri > &uri, FileInfoOptions options, guint items_per_notification, int priority, const SlotLoadDirectory &slot)
 
void transfer (const ListHandleUris &source_uri_list, const ListHandleUris &target_uri_list, TransferOptions xfer_options, ErrorMode error_mode, OverwriteMode overwrite_mode, int priority, const SlotTransferProgress &progress_update_callback, const Transfer2::SlotProgress &progress_sync_callback)
 
void find_directory (const ListHandleUris &near_uri_list, FindDirectoryKind kind, bool create_if_needed, bool find_if_needed, guint permissions, int priority, const SlotFindDirectory &slot)
 
void file_control (const Glib::ustring &operation, gpointer operation_data, const SlotFileControl &slot)
 
void cancel ()
 Cancel an asynchronous operation and close all its callbacks.
 
GnomeVFSAsyncHandle * gobj ()
 
const GnomeVFSAsyncHandle * gobj () const
 
GnomeVFSAsyncHandle ** gobj_addr ()
 

Protected Attributes

GnomeVFSAsyncHandle * gobject_
 

Member Typedef Documentation

typedef sigc::slot<void, const Async2::Handle&, Result, gpointer> Gnome::Vfs::Async2::Handle::SlotFileControl
typedef sigc::slot<void, const Async2::Handle&, Result, Glib::ListHandle<Glib::RefPtr<FileInfo> >, int> Gnome::Vfs::Async2::Handle::SlotLoadDirectory
typedef sigc::slot<void, const Async2::Handle&, Result> Gnome::Vfs::Async2::Handle::SlotOpen
typedef sigc::slot<void, const Async2::Handle&, const Glib::RefPtr<Glib::IOChannel>&, Result> Gnome::Vfs::Async2::Handle::SlotOpenAsChannel
typedef sigc::slot<void, const Async2::Handle&, Result, gpointer, FileSize, FileSize> Gnome::Vfs::Async2::Handle::SlotRead
typedef sigc::slot<void, const Async2::Handle&, Result, const Glib::RefPtr<FileInfo>& > Gnome::Vfs::Async2::Handle::SlotSetFileInfo
typedef sigc::slot<void, const Async2::Handle&, Result, gconstpointer, FileSize, FileSize> Gnome::Vfs::Async2::Handle::SlotWrite

Member Enumeration Documentation

Possible pre-set values for a job's priority.

It's best to use PRIORITY_DEFAULT unless you have a reason to do otherwise.

Enumerator
PRIORITY_DEFAULT 

The minimuum priority a job can have.

PRIORITY_MIN 

The maximuum priority a job can have.

PRIORITY_MAX 

The default job priority.

Its best to use this unless you have a reason to do otherwise.

Constructor & Destructor Documentation

Gnome::Vfs::Async2::Handle::Handle ( )
Gnome::Vfs::Async2::Handle::~Handle ( )

Member Function Documentation

void Gnome::Vfs::Async2::Handle::cancel ( )

Cancel an asynchronous operation and close all its callbacks.

Its possible to still receive another call or two on the callback.

Parameters
handleHandle of the async operation to be cancelled.
void Gnome::Vfs::Async2::Handle::close ( const SlotClose slot)
void Gnome::Vfs::Async2::Handle::create ( const Glib::ustring &  text_uri,
OpenMode  open_mode,
bool  exclusive,
guint  perm,
int  priority,
const SlotOpen slot 
)
void Gnome::Vfs::Async2::Handle::create ( const Glib::RefPtr< Uri > &  uri,
OpenMode  open_mode,
bool  exclusive,
guint  perm,
int  priority,
const SlotOpen slot 
)
void Gnome::Vfs::Async2::Handle::create_as_channel ( const Glib::ustring &  text_uri,
OpenMode  open_mode,
bool  exclusive,
guint  perm,
int  priority,
const SlotCreateAsChannel slot 
)
void Gnome::Vfs::Async2::Handle::create_symbolic_link ( const Glib::RefPtr< Uri > &  uri,
const Glib::ustring &  uri_reference,
int  priority,
const SlotOpen slot 
)
void Gnome::Vfs::Async2::Handle::file_control ( const Glib::ustring &  operation,
gpointer  operation_data,
const SlotFileControl slot 
)
void Gnome::Vfs::Async2::Handle::find_directory ( const ListHandleUris near_uri_list,
FindDirectoryKind  kind,
bool  create_if_needed,
bool  find_if_needed,
guint  permissions,
int  priority,
const SlotFindDirectory slot 
)
void Gnome::Vfs::Async2::Handle::get_file_info ( const ListHandleUris uri_list,
FileInfoOptions  options,
int  priority,
const SlotGetFileInfo slot 
) const
GnomeVFSAsyncHandle* Gnome::Vfs::Async2::Handle::gobj ( )
inline

References gobject_.

const GnomeVFSAsyncHandle* Gnome::Vfs::Async2::Handle::gobj ( ) const
inline

References gobject_.

GnomeVFSAsyncHandle** Gnome::Vfs::Async2::Handle::gobj_addr ( )
inline

References gobject_.

void Gnome::Vfs::Async2::Handle::load_directory ( const Glib::ustring &  text_uri,
FileInfoOptions  options,
guint  items_per_notification,
int  priority,
const SlotLoadDirectory slot 
)
void Gnome::Vfs::Async2::Handle::load_directory ( const Glib::RefPtr< Uri > &  uri,
FileInfoOptions  options,
guint  items_per_notification,
int  priority,
const SlotLoadDirectory slot 
)
void Gnome::Vfs::Async2::Handle::open ( const Glib::ustring &  text_uri,
OpenMode  open_mode,
int  priority,
const SlotOpen slot 
)
void Gnome::Vfs::Async2::Handle::open ( const Glib::RefPtr< Uri > &  uri,
OpenMode  open_mode,
int  priority,
const SlotOpen slot 
)
void Gnome::Vfs::Async2::Handle::open_as_channel ( const Glib::ustring &  text_uri,
OpenMode  open_mode,
guint  advised_block_size,
int  priority,
const SlotOpenAsChannel slot 
)
void Gnome::Vfs::Async2::Handle::open_as_channel ( const Glib::RefPtr< Uri > &  uri,
OpenMode  open_mode,
guint  advised_block_size,
int  priority,
const SlotOpenAsChannel slot 
)
void Gnome::Vfs::Async2::Handle::read ( gpointer  buffer,
guint  bytes,
const SlotRead slot 
)
void Gnome::Vfs::Async2::Handle::set_file_info ( const Glib::RefPtr< Uri > &  uri,
const Glib::RefPtr< FileInfo > &  info,
SetFileInfoMask  mask,
FileInfoOptions  options,
int  priority,
const SlotSetFileInfo slot 
)
void Gnome::Vfs::Async2::Handle::transfer ( const ListHandleUris source_uri_list,
const ListHandleUris target_uri_list,
TransferOptions  xfer_options,
ErrorMode  error_mode,
OverwriteMode  overwrite_mode,
int  priority,
const SlotTransferProgress progress_update_callback,
const Transfer2::SlotProgress progress_sync_callback 
)
void Gnome::Vfs::Async2::Handle::write ( gconstpointer  buffer,
guint  bytes,
const SlotWrite slot 
)

Member Data Documentation

GnomeVFSAsyncHandle* Gnome::Vfs::Async2::Handle::gobject_
protected

Referenced by gobj(), and gobj_addr().


The documentation for this class was generated from the following file: