libgnome-vfsmm-2.6-dev 2.26.0-1build1 / usr / include / gnome-vfsmm-2.6 / libgnomevfsmm / async-handle-2.h

// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _LIBGNOMEVFSMM_ASYNC_HANDLE_2_H
#define _LIBGNOMEVFSMM_ASYNC_HANDLE_2_H


#include <glibmm.h>

// -*- c++ -*-
/* Copyright 2003, 2006 gnome-vfsmm Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include <libgnomevfs/gnome-vfs-async-ops.h>
#include <libgnomevfs/gnome-vfs-file-info.h>

#include <libgnomevfsmm/enums.h>
#include <libgnomevfsmm/file-info.h>
#include <libgnomevfsmm/uri.h>
#include <libgnomevfsmm/transfer-2.h>


namespace Gnome
{

namespace Vfs
{

/** Encapsulates the details of an individual file
 * info request that was part of a mass file info request launched
 * through Async2::Handle::get_file_info(), and is passed to a
 * Async2::Handle::SlotGetFileInfo.
 */
class FileInfoResult
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef FileInfoResult CppObjectType;
  typedef GnomeVFSGetFileInfoResult BaseObjectType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

  FileInfoResult();

  // Use make_a_copy=true when getting it directly from a struct.
  explicit FileInfoResult(GnomeVFSGetFileInfoResult* castitem, bool make_a_copy = false);

  FileInfoResult(const FileInfoResult& src);
  FileInfoResult& operator=(const FileInfoResult& src);

  ~FileInfoResult();

  GnomeVFSGetFileInfoResult*       gobj()       { return gobject_; }
  const GnomeVFSGetFileInfoResult* gobj() const { return gobject_; }

  ///Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
  GnomeVFSGetFileInfoResult* gobj_copy() const;

protected:
  GnomeVFSGetFileInfoResult* gobject_;

private:

  
public:

   Glib::RefPtr<Uri> get_uri() const;
    Result get_result() const;
    Glib::RefPtr<FileInfo> get_file_info() const;
 

};


/** This class is passed to a Async2::Handle::SlotFindDirectory
 * by Async2::Handle::find_directory() and contains the information
 * associated with a single Gnome::Vfs::Uri matching the specified find request.
 */
class FindDirectoryResult
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef FindDirectoryResult CppObjectType;
  typedef GnomeVFSFindDirectoryResult BaseObjectType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

  FindDirectoryResult();

  // Use make_a_copy=true when getting it directly from a struct.
  explicit FindDirectoryResult(GnomeVFSFindDirectoryResult* castitem, bool make_a_copy = false);

  FindDirectoryResult(const FindDirectoryResult& src);
  FindDirectoryResult& operator=(const FindDirectoryResult& src);

  ~FindDirectoryResult();

  GnomeVFSFindDirectoryResult*       gobj()       { return gobject_; }
  const GnomeVFSFindDirectoryResult* gobj() const { return gobject_; }

  ///Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
  GnomeVFSFindDirectoryResult* gobj_copy() const;

protected:
  GnomeVFSFindDirectoryResult* gobject_;

private:

  
   Glib::RefPtr<Uri> get_uri() const;
    Result get_result() const;
 

};


/** @addtogroup libgnomevfsmmEnums Enums and Flags */

/**
 * @ingroup libgnomevfsmmEnums
 */
enum FindDirectoryKind
{
  DIRECTORY_KIND_DESKTOP = 1000,
  DIRECTORY_KIND_TRASH
};


/** Asynchronous file operations: POSIX-style file operations
 * that run outside your main loop
 */
namespace Async2
{

typedef Glib::ListHandle< Glib::RefPtr<const Uri> > ListHandleUris;

#ifndef DOXYGEN_SHOULD_SKIP_THIS
struct FileInfoResultTraits
{
  typedef FileInfoResult  CppType;
  typedef const GnomeVFSGetFileInfoResult*    CType;
  typedef GnomeVFSGetFileInfoResult*    CTypeNonConst;

  static CType   to_c_type      (const CppType& obj) { return obj.gobj(); }
  static CType   to_c_type      (const CType&   obj) { return obj; }
  static CppType to_cpp_type    (const CType&   obj) { return CppType(const_cast<CTypeNonConst>(obj), true); }
  static void    release_c_type (const CType&)       {}
};
#endif //DOXYGEN_SHOULD_SKIP_THIS

typedef Glib::ListHandle< FileInfoResult, FileInfoResultTraits > ListHandleFileInfoResults;

#ifndef DOXYGEN_SHOULD_SKIP_THIS
struct FindDirectoryResultTraits
{
  typedef FindDirectoryResult  CppType;
  typedef const GnomeVFSFindDirectoryResult*    CType;
  typedef GnomeVFSFindDirectoryResult*    CTypeNonConst;

  static CType   to_c_type      (const CppType& obj) { return obj.gobj(); }
  static CType   to_c_type      (const CType&   obj) { return obj; }
  static CppType to_cpp_type    (const CType&   obj) { return CppType(const_cast<CTypeNonConst>(obj), true); }
  static void    release_c_type (const CType&)       {}
};
#endif //DOXYGEN_SHOULD_SKIP_THIS

typedef Glib::ListHandle< FindDirectoryResult, FindDirectoryResultTraits > ListHandleFindDirectoryResult;


//The default constructor creates a null handle. Use an open*() method before anything else.
class Handle
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef Handle CppObjectType;
  typedef GnomeVFSAsyncHandle BaseObjectType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

private:

  
public:
  Handle();
  ~Handle();

  typedef sigc::slot<void, const Async2::Handle&, Result> SlotOpen;
  typedef SlotOpen SlotClose;

  //This is our C++ equivalent for GNOME_VFS_PRIORITY_MIN, GNOME_VFS_PRIORITY_MAX, and GNOME_VFS_PRIORITY_DEFAULT:
  /** Possible pre-set values for a job's priority.
   * It's best to use PRIORITY_DEFAULT unless you have a reason to do otherwise.
   */
  enum Priority
  {
    PRIORITY_DEFAULT =   0, /**<  The minimuum priority a job can have. */
    PRIORITY_MIN     = -10, /**<  The maximuum priority a job can have. */
    PRIORITY_MAX     =  10 /**<  The default job priority. Its best to use this unless you have a reason to do otherwise. */
  };

  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);

  typedef sigc::slot<void, const Async2::Handle&, const Glib::RefPtr<Glib::IOChannel>&, Result> SlotOpenAsChannel;
  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);

  typedef SlotOpenAsChannel SlotCreateAsChannel;
  void create_as_channel(const Glib::ustring& text_uri, OpenMode open_mode, bool exclusive, guint perm, int priority, const SlotCreateAsChannel& slot);
  //gnome_vfs_async_create_uri_as_channel() is declared, but not defined in gnome-vfs.
  //void create_as_channel(const Glib::RefPtr<Uri> uri, OpenMode open_mode, bool exclusive, guint perm, int priority, const SlotCreateAsChannel& slot);

  void close(const SlotClose& slot);

  typedef sigc::slot<void, const Async2::Handle&, Result, gpointer, FileSize, FileSize> SlotRead;
  void read(gpointer buffer, guint bytes, const SlotRead& slot);

  typedef sigc::slot<void, const Async2::Handle&, Result, gconstpointer, FileSize, FileSize> SlotWrite;
  void write(gconstpointer buffer, guint bytes, const SlotWrite& slot);

  typedef sigc::slot<void, const Async2::Handle&, ListHandleFileInfoResults > SlotGetFileInfo;
  void get_file_info(const ListHandleUris& uri_list, FileInfoOptions options, int priority, const SlotGetFileInfo& slot) const;

  typedef sigc::slot<void, const Async2::Handle&, Result, const Glib::RefPtr<FileInfo>& > SlotSetFileInfo;
  void set_file_info(const Glib::RefPtr<Uri>& uri, const Glib::RefPtr<FileInfo>& info, SetFileInfoMask mask, FileInfoOptions options, int priority, const SlotSetFileInfo& slot);

  typedef sigc::slot<void, const Async2::Handle&, Result, Glib::ListHandle<Glib::RefPtr<FileInfo> >, int> SlotLoadDirectory;
  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);

  typedef sigc::slot<int, const Async2::Handle&, Transfer2::ProgressInfo&> SlotTransferProgress;

#ifdef GLIBMM_EXCEPTIONS_ENABLED
  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);
#else
  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, std::auto_ptr<Gnome::Vfs::exception>& error);
#endif

  typedef sigc::slot<void, const Async2::Handle&, ListHandleFindDirectoryResult > SlotFindDirectory;
  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);

  typedef sigc::slot<void, const Async2::Handle&, Result, gpointer> SlotFileControl;
  void file_control(const Glib::ustring& operation, gpointer operation_data, const SlotFileControl& slot);

  
  /** Cancel an asynchronous operation and close all its callbacks.
   * Its possible to still receive another call or two on the callback.
   * @param handle Handle of the async operation to be cancelled.
   */

  void cancel();

  GnomeVFSAsyncHandle*       gobj()       { return gobject_; }
  const GnomeVFSAsyncHandle* gobj() const { return gobject_; }
  GnomeVFSAsyncHandle**      gobj_addr()  { return &gobject_; }
  
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  void assign_gobj(GnomeVFSAsyncHandle* src);
#endif

protected:
  GnomeVFSAsyncHandle* gobject_;
  
private:
  Handle(const Handle&);
  Handle& operator=(const Handle&);


};

} // namespace Async2
} // namespace Vfs
} // namespace Gnome

#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{

template <>
class Value<Gnome::Vfs::FindDirectoryKind> : public Glib::Value_Flags<Gnome::Vfs::FindDirectoryKind>
{
public:
  static GType value_type() G_GNUC_CONST;
};

} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */


namespace Glib
{

  /** A Glib::wrap() method for this object.
   * 
   * @param object The C instance.
   * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
   * @result A C++ instance that wraps this C instance.
   *
   * @relates Gnome::Vfs::FileInfoResult
   */
Gnome::Vfs::FileInfoResult wrap(GnomeVFSGetFileInfoResult* object, bool take_copy = false);

} // namespace Glib


namespace Glib
{

  /** A Glib::wrap() method for this object.
   * 
   * @param object The C instance.
   * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
   * @result A C++ instance that wraps this C instance.
   *
   * @relates Gnome::Vfs::FindDirectoryResult
   */
Gnome::Vfs::FindDirectoryResult wrap(GnomeVFSFindDirectoryResult* object, bool take_copy = false);

} // namespace Glib


#endif /* _LIBGNOMEVFSMM_ASYNC_HANDLE_2_H */