root/trunk/src/JobRender.h

Revision 148, 2.0 kB (checked in by jordi, 2 years ago)

Added all missing comments for all functions.

Line 
1// ePDFView - A lightweight PDF Viewer.
2// Copyright (C) 2006 Emma's Software.
3//
4// This program is free software; you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation; either version 2 of the License, or
7// (at your option) any later version.
8//
9// This program is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with this program; if not, write to the Free Software
16// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
18#if !defined (__JOB_RENDER_H__)
19#define __JOB_RENDER_H__
20
21namespace ePDFView
22{
23    ///
24    /// @class JobRender
25    /// @brief A background job that renders a page.
26    ///
27    /// This class is used to render a single page. Render means not only
28    /// get the image but also the links on that page.
29    ///
30    class JobRender: public IJob
31    {
32        public:
33            JobRender ();
34            ~JobRender ();
35
36            gboolean run (void);
37
38            guint32 getAge (void);
39            IDocument *getDocument (void);
40            DocumentPage *getPageImage (void);
41            gint getPageNumber (void);
42            void setAge (guint32 age);
43            void setDocument (IDocument *document);
44            void setPageNumber (gint pageNumber);
45
46            static gboolean m_CanProcessJobs;
47            static void setMinAge (guint32 age);
48
49        protected:
50            /// The job's age.
51            guint32 m_Age;
52            /// The class to use to render the page.
53            IDocument *m_Document;
54            static guint32 m_MinAge;
55            /// The page's rendered image.
56            DocumentPage *m_PageImage;
57            /// The page's number to render.
58            gint m_PageNumber;
59
60    };
61}
62
63#endif // !__JOB_RENDER_H__
Note: See TracBrowser for help on using the browser.