pdf_search_task.h

Go to the documentation of this file.
00001 /*
00002  * File Name: pdf_search_task.h
00003  */
00004 
00005 /*
00006  * This file is part of uds-plugin-pdf.
00007  *
00008  * uds-plugin-pdf is free software: you can redistribute it and/or modify
00009  * it under the terms of the GNU General Public License as published by
00010  * the Free Software Foundation, either version 2 of the License, or
00011  * (at your option) any later version.
00012  *
00013  * uds-plugin-pdf is distributed in the hope that it will be useful,
00014  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00015  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
00016  * GNU General Public License for more details.
00017  *
00018  * You should have received a copy of the GNU General Public License
00019  * along with this program. If not, see <http://www.gnu.org/licenses/>.
00020  */
00021 
00022 /**
00023  * Copyright (C) 2008 iRex Technologies B.V.
00024  * All rights reserved.
00025  */
00026 
00027 #ifndef PDF_SEARCH_TASK_H_
00028 #define PDF_SEARCH_TASK_H_
00029 
00030 #include "task.h"
00031 
00032 #include "pdf_define.h"
00033 #include "pdf_searcher.h"
00034 
00035 namespace pdf
00036 {
00037 
00038 /// @brief The search task.
00039 class PDFSearchTask : public Task
00040 {
00041 public:
00042     PDFSearchTask(const PDFSearchCriteria &c
00043                   , const string &anchor
00044                   , PDFSearchType t
00045                   , PDFSearcher *s
00046                   , unsigned int id);
00047 
00048     virtual ~PDFSearchTask();
00049 
00050     /// @brief execute the rendering task
00051     void  execute();
00052 
00053     /// @brief get the pointer of document instance
00054     void* get_user_data();
00055 
00056     /// @brief get search id
00057     unsigned int get_id();
00058 
00059 private:
00060     // The search type
00061     PDFSearchType search_type;
00062 
00063     // The reference to the searcher
00064     PDFSearcher *searcher;
00065 
00066     // The search criteria
00067     PDFSearchCriteria criteria;
00068 
00069     // The from anchor
00070     string from_anchor;
00071 
00072     // The search id
00073     unsigned int search_id;
00074 };
00075 
00076 };//namespace pdf
00077 
00078 #endif //PDF_SEARCH_TASK_H_
00079 
Generated by  doxygen 1.6.2-20100208