File: request.h

package info (click to toggle)
splix 2.0.0-2.2
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 2,912 kB
  • ctags: 653
  • sloc: cpp: 4,514; makefile: 332; sh: 86; ansic: 42
file content (134 lines) | stat: -rw-r--r-- 4,166 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*
 * 	    request.h                 (C) 2006-2008, Aurélien Croc (AP²C)
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; version 2 of the License.
 * 
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the
 *  Free Software Foundation, Inc.,
 *  59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 *  $Id: request.h 151 2008-02-02 20:21:34Z ap2c $
 * 
 */
#ifndef _REQUEST_H_
#define _REQUEST_H_

#include "printer.h"

class PPDFile;

/**
  * @brief This class contains all the information about the requested job.
  *
  * During the job information loading, this class will instantiate @ref Printer
  * and initialize it to have information on the printer which will be used to
  * print the job.
  * This instance is mainly used by the QPDL render.
  */
class Request 
{
    public:
        /**
          * List the duplex modes.
          */
        enum Duplex {
            /** Simplex mode. */
            Simplex,
            /** Duplex mode by the long edge. */
            LongEdge,
            /** Duplex mode by the short edge. */
            ShortEdge,
            /** Manual duplex mode by the long edge. */
            ManualLongEdge,
            /** Manual duplex mode by the short edge. */
            ManualShortEdge,
        };

    protected:
        PPDFile*                _ppd;

        const char*             _username;
        const char*             _jobname;
        const char*             _jobtitle;
        unsigned long           _copiesNr;

        Printer                 _printer;

        Duplex                  _duplex;
        bool                    _reverseDuplex;

    public:
        /**
          * Initialize the instance.
          */
        Request();
        /**
          * Destroy the instance.
          */
        virtual ~Request();

    public:
        /**
          * Load a new request.
          * @param ppd the PPDfile instance
          * @param jobname the job ID
          * @param username the name of the user which make this job
          * @param jobtitle the job title
          * @param copiesNr the number of copies to print
          * @return TRUE if the request has been successfully loaded. Otherwise
          *         it returns FALSE.
          */
        bool                    loadRequest(PPDFile* ppd, 
                                    const char *jobname, const char *username, 
                                    const char *jobtitle, 
                                    unsigned long copiesNr);

    public:
        /**
         * Update the duplex mode.
         */
        void                    setDuplex (Duplex duplex) {_duplex = duplex;}

        /**
          * @return the PPDFile instance.
          */
        PPDFile*                ppd() const {return _ppd;}
        /**
          * @return the printer instance.
          */
        const Printer*          printer() const {return &_printer;}
        /**
          * @return the duplex mode.
          */ 
        Duplex                  duplex() const {return _duplex;}
        /**
          * @return TRUE if it's a reversed duplex. Otherwise it returns FALSE.
          */
        bool                    reverseDuplex() const {return _reverseDuplex;}
        /**
          * @return the user name.
          */
        const char*             userName() const {return _username;}
        /**
          * @return the job name.
          */
        const char*             jobName() const {return _jobname;}
        /**
          * @return the job title.
          */
        const char*             jobTitle() const {return _jobtitle;}

};

#endif /* _REQUEST_H_ */

/* vim: set expandtab tabstop=4 shiftwidth=4 smarttab tw=80 cin enc=utf8: */