src/libcaptive/include/captive/client-directory.h

   1 /* $Id$
   2  * Include file with client-application 'directory' access to libcaptive
   3  * Copyright (C) 2002 Jan Kratochvil <project-captive@jankratochvil.net>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; exactly version 2 of June 1991 is required
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19
  20 #ifndef _CAPTIVE_CLIENT_DIRECTORY_H
  21 #define _CAPTIVE_CLIENT_DIRECTORY_H 1
  22
  23
  24 #include <glib/gmacros.h>
  25 #include <glib-object.h>
  26 #include <libgnomevfs/gnome-vfs-file-info.h>    /* for GnomeVFSFileInfo */
  27 #include "captive/client-file-info.h"
  28 #include "captive/client-vfs.h"
  29
  30
  31 G_BEGIN_DECLS
  32
  33 #define CAPTIVE_DIRECTORY_TYPE_OBJECT            (captive_directory_object_get_type())
  34 #define CAPTIVE_DIRECTORY_OBJECT(object)         (G_TYPE_CHECK_INSTANCE_CAST((object),CAPTIVE_DIRECTORY_TYPE_OBJECT,CaptiveDirectoryObject))
  35 #define CAPTIVE_DIRECTORY_OBJECT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass),CAPTIVE_DIRECTORY_TYPE_OBJECT,CaptiveDirectoryObjectClass))
  36 #define CAPTIVE_DIRECTORY_IS_OBJECT(object)      (G_TYPE_CHECK_INSTANCE_TYPE((object),CAPTIVE_DIRECTORY_TYPE_OBJECT))
  37 #define CAPTIVE_DIRECTORY_IS_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),CAPTIVE_DIRECTORY_TYPE_OBJECT))
  38 #define CAPTIVE_DIRECTORY_OBJECT_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj),CAPTIVE_DIRECTORY_TYPE_OBJECT,CaptiveDirectoryObjectClass))
  39 typedef struct _CaptiveDirectoryObject      CaptiveDirectoryObject;
  40 typedef struct _CaptiveDirectoryObjectClass CaptiveDirectoryObjectClass;
  41
  42
  43 GType captive_directory_object_get_type(void);
  44
  45 GnomeVFSResult captive_directory_new_open(CaptiveDirectoryObject **captive_directory_object_return,
  46                 CaptiveVfsObject *captive_vfs_object,const gchar *pathname);
  47 GnomeVFSResult captive_directory_new_make(CaptiveDirectoryObject **captive_directory_object_return,
  48                 CaptiveVfsObject *captive_vfs_object,const gchar *pathname,guint perm);
  49 CaptiveVfsObject *captive_directory_ref_vfs(CaptiveDirectoryObject *captive_directory_object);
  50 GnomeVFSResult captive_directory_read(CaptiveDirectoryObject *captive_directory_object,
  51                 CaptiveFileInfoObject **captive_file_info_object_return);
  52 GnomeVFSResult captive_directory_remove(CaptiveDirectoryObject *captive_directory_object);
  53
  54
  55 G_END_DECLS
  56
  57
  58 #endif /* _CAPTIVE_CLIENT_DIRECTORY_H */