gmime/gmime-part-iter.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*  GMime
   3  *  Copyright (C) 2000-2012 Jeffrey Stedfast
   4  *
   5  *  This library is free software; you can redistribute it and/or
   6  *  modify it under the terms of the GNU Lesser General Public License
   7  *  as published by the Free Software Foundation; either version 2.1
   8  *  of the License, or (at your option) any later version.
   9  *
  10  *  This library is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  *  Lesser General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU Lesser General Public
  16  *  License along with this library; if not, write to the Free
  17  *  Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
  18  *  02110-1301, USA.
  19  */
  20
  21
  22 #ifndef __GMIME_PART_ITER_H__
  23 #define __GMIME_PART_ITER_H__
  24
  25 #include <gmime/gmime-object.h>
  26
  27 G_BEGIN_DECLS
  28
  29 /**
  30  * GMimePartIter:
  31  *
  32  * A MIME part iterator.
  33  **/
  34 typedef struct _GMimePartIter GMimePartIter;
  35
  36 GMimePartIter *g_mime_part_iter_new (GMimeObject *toplevel);
  37 void g_mime_part_iter_free (GMimePartIter *iter);
  38
  39 void g_mime_part_iter_reset (GMimePartIter *iter);
  40
  41 gboolean g_mime_part_iter_jump_to (GMimePartIter *iter, const char *path);
  42
  43 gboolean g_mime_part_iter_is_valid (GMimePartIter *iter);
  44
  45 gboolean g_mime_part_iter_next (GMimePartIter *iter);
  46 gboolean g_mime_part_iter_prev (GMimePartIter *iter);
  47
  48 GMimeObject *g_mime_part_iter_get_toplevel (GMimePartIter *iter);
  49 GMimeObject *g_mime_part_iter_get_current (GMimePartIter *iter);
  50 GMimeObject *g_mime_part_iter_get_parent (GMimePartIter *iter);
  51 char *g_mime_part_iter_get_path (GMimePartIter *iter);
  52
  53 gboolean g_mime_part_iter_replace (GMimePartIter *iter, GMimeObject *replacement);
  54 gboolean g_mime_part_iter_remove (GMimePartIter *iter);
  55
  56 G_END_DECLS
  57
  58 #endif /* __GMIME_PART_ITER_H__ */