RFilter

RFilter

Synopsis




#define             R_FILTER_TYPE
                    RFilterPrivate;
                    RFilter;
RFilter*            r_filter_new                        (void);
void                r_filter_free                       (RFilter *filter);
RFilter*            r_filter_copy                       (RFilter *filter);
void                r_filter_add_pattern                (RFilter *filter,
                                                         gchar *pattern);
gboolean            r_filter_delete_pattern             (RFilter *filter,
                                                         gchar *pattern);
void                r_filter_reset                      (RFilter *filter);
gchar*              r_filter_get_pattern                (RFilter *filter);
gchar*              r_filter_get_next_pattern           (RFilter *filter);

Object Hierarchy


  GObject
   +----RFilter

Properties


  "filter-extension"         gchararray            : Read / Write / Construct
  "filter-mime"              gchararray            : Read / Write / Construct
  "filter-name"              gchararray            : Read / Write / Construct

Description

Details

R_FILTER_TYPE

#define R_FILTER_TYPE            (r_filter_get_type())


RFilterPrivate

typedef struct _RFilterPrivate RFilterPrivate;


RFilter

typedef struct _RFilter RFilter;


r_filter_new ()

RFilter*            r_filter_new                        (void);

create a new RFilter

Returns :

a RFilter*

r_filter_free ()

void                r_filter_free                       (RFilter *filter);

free memory

filter :

a RFilter

r_filter_copy ()

RFilter*            r_filter_copy                       (RFilter *filter);

copy the given RFilter

filter :

a RFilter

Returns :

a new RFilter or NULL if an error occurred

r_filter_add_pattern ()

void                r_filter_add_pattern                (RFilter *filter,
                                                         gchar *pattern);

append the given pattern to the filter's list

filter :

a RFilter

pattern :

a gchar*

r_filter_delete_pattern ()

gboolean            r_filter_delete_pattern             (RFilter *filter,
                                                         gchar *pattern);

delete the given pattern from the filter's list

filter :

a RFilter

pattern :

a gchar*

Returns :

TRUE if pattern is succesfully deleted, FALSE otherwise

r_filter_reset ()

void                r_filter_reset                      (RFilter *filter);

reset the private filter's iterator

filter :

a RFilter

r_filter_get_pattern ()

gchar*              r_filter_get_pattern                (RFilter *filter);

get the first filter's pattern

filter :

a RFilter

Returns :

a gchar* or NULL if filter doesn't have patterns

r_filter_get_next_pattern ()

gchar*              r_filter_get_next_pattern           (RFilter *filter);

get the next filter's pattern

filter :

a RFilter

Returns :

a gchar* or NULL if filter doesn't have more patterns

Property Details

The "filter-extension" property

  "filter-extension"         gchararray            : Read / Write / Construct

extension added to file' name

Default value: NULL


The "filter-mime" property

  "filter-mime"              gchararray            : Read / Write / Construct

the name of the filter

Default value: NULL


The "filter-name" property

  "filter-name"              gchararray            : Read / Write / Construct

the name of the filter

Default value: NULL