Evince Document Library Reference Manual: EvDocumentFind

## EvDocumentFind EvDocumentFind |

## Synopsis

                        EvDocumentFind;
    struct              EvDocumentFindInterface;
    enum                EvFindOptions;
    GList *             ev_document_find_find_text          (EvDocumentFind *document_find,
                                                             EvPage *page,
                                                             const gchar *text,
                                                             gboolean case_sensitive);
    GList *             ev_document_find_find_text_with_options
                                                            (EvDocumentFind *document_find,
                                                             EvPage *page,
                                                             const gchar *text,
                                                             EvFindOptions options);
    EvFindOptions       ev_document_find_get_supported_options
                                                            (EvDocumentFind *document_find);

## Object Hierarchy

      GInterface
       +----EvDocumentFind

      GFlags
       +----EvFindOptions

## Description

## Details

### EvDocumentFind

    typedef struct _EvDocumentFind EvDocumentFind;

### struct EvDocumentFindInterface

    struct EvDocumentFindInterface {
    	GTypeInterface base_iface;

            /* Methods */
    	GList 	     *(* find_text)              (EvDocumentFind *document_find,
    						  EvPage         *page,
    						  const gchar    *text,
    						  gboolean        case_sensitive);
    	GList        *(* find_text_with_options) (EvDocumentFind *document_find,
    						  EvPage         *page,
    						  const gchar    *text,
    						  EvFindOptions   options);
    	EvFindOptions (*get_supported_options)   (EvDocumentFind *document_find);
    };

### enum EvFindOptions

    typedef enum {
    	EV_FIND_DEFAULT          = 0,
    	EV_FIND_CASE_SENSITIVE   = 1 << 0,
    	EV_FIND_WHOLE_WORDS_ONLY = 1 << 1
    } EvFindOptions;

`EV_FIND_DEFAULT` |
`EV_FIND_CASE_SENSITIVE` |
`EV_FIND_WHOLE_WORDS_ONLY` |

### ev_document_find_find_text ()

    GList *             ev_document_find_find_text          (EvDocumentFind *document_find,
                                                             EvPage *page,
                                                             const gchar *text,
                                                             gboolean case_sensitive);

`document_find` : | an EvDocumentFind
`page` : | an EvPage
`text` : | text to find
`case_sensitive` : | whether to match the string case
Returns : | a list of results. [transfer full][element-type EvRectangle]

### ev_document_find_find_text_with_options ()

    GList *             ev_document_find_find_text_with_options
                                                            (EvDocumentFind *document_find,
                                                             EvPage *page,
                                                             const gchar *text,
                                                             EvFindOptions options);

### ev_document_find_get_supported_options ()

    EvFindOptions       ev_document_find_get_supported_options
                                                            (EvDocumentFind *document_find);