xref: /trunk/main/vcl/inc/vcl/jobset.hxx (revision 75252d1be01e1cf45dd76dccad77de5397f80874)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef _SV_JOBSET_HXX
25 #define _SV_JOBSET_HXX
26 
27 #include <tools/string.hxx>
28 #include <vcl/sv.h>
29 #include <vcl/dllapi.h>
30 #include <vcl/prntypes.hxx>
31 
32 class SvStream;
33 struct ImplJobSetup;
34 
35 // ------------
36 // - JobSetup -
37 // ------------
38 
39 class VCL_DLLPUBLIC JobSetup
40 {
41     friend class Printer;
42 
43 private:
44     ImplJobSetup*       mpData;
45 
46 //#if 0 // _SOLAR__PRIVATE
47 public:
48     SAL_DLLPRIVATE ImplJobSetup*        ImplGetData();
49     SAL_DLLPRIVATE ImplJobSetup*        ImplGetConstData();
50     SAL_DLLPRIVATE const ImplJobSetup*  ImplGetConstData() const;
51 //#endif
52 
53 public:
54                         JobSetup();
55                         JobSetup( const JobSetup& rJob );
56                         ~JobSetup();
57 
58     String              GetPrinterName() const;
59     String              GetDriverName() const;
60 
61     /*  Get/SetValue are used to read/store additional
62      *  Parameters in the job setup that may be used
63      *  by the printer driver. One possible use are phone
64      *  numbers for faxes (which disguise as printers)
65      */
66     String              GetValue( const String& rKey ) const;
67     void                SetValue( const String& rKey, const String& rValue );
68 
69     JobSetup&           operator=( const JobSetup& rJob );
70 
71     sal_Bool                operator==( const JobSetup& rJobSetup ) const;
72     sal_Bool                operator!=( const JobSetup& rJobSetup ) const
73                             { return !(JobSetup::operator==( rJobSetup )); }
74 
75     friend VCL_DLLPUBLIC SvStream&  operator>>( SvStream& rIStream, JobSetup& rJobSetup );
76     friend VCL_DLLPUBLIC SvStream&  operator<<( SvStream& rOStream, const JobSetup& rJobSetup );
77 };
78 
79 #endif  // _SV_JOBSET_HXX
80