ROX-Filer/src/global.h

   1 /*
   2  * $Id$
   3  *
   4  * ROX-Filer, filer for the ROX desktop project
   5  * By Thomas Leonard, <tal197@users.sourceforge.net>.
   6  */
   7
   8 /* global.h is included by most of the other source files, just after
   9  * including config.h and the system header files, but before any other
  10  * ROX-Filer header files.
  11  */
  12
  13 #include <glib.h>
  14
  15 /* We typedef various pointers here to avoid creating unnecessary
  16  * dependencies on the other header files.
  17  */
  18
  19 /* Each filer window has one of these all to itself */
  20 typedef struct _FilerWindow FilerWindow;
  21
  22 /* There is one Directory object per cached disk directory inode number.
  23  * Multiple FilerWindows may share a single directory. Directories
  24  * are cached, so a Directories may exist without any filer windows
  25  * referencing it at all.
  26  */
  27 typedef struct _Directory Directory;
  28
  29 /* Each item in a directory has a DirItem. The contains information from
  30  * stat()ing the file, plus a few other bits. There may be several of these
  31  * for a single file, if it appears (hard-linked) in several directories.
  32  */
  33 typedef struct _DirItem DirItem;
  34
  35 /* This contains pixmaps and masks for an image, and (sometimes) a
  36  * half-sized version.
  37  */
  38 typedef struct _MaskedPixmap MaskedPixmap;
  39
  40 /* Each MIME type (eg 'text/plain') has one of these. It contains
  41  * a link to the image and the type's name (used so that the image can
  42  * be refreshed, amoung other things).
  43  */
  44 typedef struct _MIME_type MIME_type;
  45
  46 /* There will be one of these if the pinboard is in use. It contains
  47  * the name of the pinboard and links to the pinned items inside.
  48  */
  49 typedef struct _Pinboard Pinboard;
  50
  51 /* Each icon on the pinboard has a PinIcon structure. It contains the
  52  * name, path and position of the icon, as well as its DirItem.
  53  */
  54 typedef struct _PinIcon PinIcon;
  55