gmime/gmime-filter-from.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_FILTER_FROM_H__
  23 #define __GMIME_FILTER_FROM_H__
  24
  25 #include <gmime/gmime-filter.h>
  26
  27 G_BEGIN_DECLS
  28
  29 #define GMIME_TYPE_FILTER_FROM            (g_mime_filter_from_get_type ())
  30 #define GMIME_FILTER_FROM(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GMIME_TYPE_FILTER_FROM, GMimeFilterFrom))
  31 #define GMIME_FILTER_FROM_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GMIME_TYPE_FILTER_FROM, GMimeFilterFromClass))
  32 #define GMIME_IS_FILTER_FROM(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GMIME_TYPE_FILTER_FROM))
  33 #define GMIME_IS_FILTER_FROM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GMIME_TYPE_FILTER_FROM))
  34 #define GMIME_FILTER_FROM_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GMIME_TYPE_FILTER_FROM, GMimeFilterFromClass))
  35
  36 typedef struct _GMimeFilterFrom GMimeFilterFrom;
  37 typedef struct _GMimeFilterFromClass GMimeFilterFromClass;
  38
  39
  40 /**
  41  * GMimeFilterFromMode:
  42  * @GMIME_FILTER_FROM_MODE_DEFAULT: Default mode.
  43  * @GMIME_FILTER_FROM_MODE_ESCAPE: Escape 'From ' lines with a '>'
  44  * @GMIME_FILTER_FROM_MODE_ARMOR: QP-Encode 'From ' lines
  45  *
  46  * The mode for a #GMimeFilterFrom filter.
  47  **/
  48 typedef enum {
  49         GMIME_FILTER_FROM_MODE_DEFAULT  = 0,
  50         GMIME_FILTER_FROM_MODE_ESCAPE   = 0,
  51         GMIME_FILTER_FROM_MODE_ARMOR    = 1
  52 } GMimeFilterFromMode;
  53
  54
  55 /**
  56  * GMimeFilterFrom:
  57  * @parent_object: parent #GMimeFilter
  58  * @mode: #GMimeFilterFromMode
  59  * @midline: %TRUE if in the middle of a line
  60  *
  61  * A filter for armoring or escaping lines beginning with "From ".
  62  **/
  63 struct _GMimeFilterFrom {
  64         GMimeFilter parent_object;
  65
  66         GMimeFilterFromMode mode;
  67         gboolean midline;
  68 };
  69
  70 struct _GMimeFilterFromClass {
  71         GMimeFilterClass parent_class;
  72
  73 };
  74
  75
  76 GType g_mime_filter_from_get_type (void);
  77
  78 GMimeFilter *g_mime_filter_from_new (GMimeFilterFromMode mode);
  79
  80 G_END_DECLS
  81
  82 #endif /* __GMIME_FILTER_FROM_H__ */