summaryrefslogtreecommitdiff
path: root/print/XPSDrvSmpl/src/common/pshndlr.h
blob: 22d76863438c131f5948a2b558bb9775353438e5 (plain)
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/*++

Copyright (c) 2005 Microsoft Corporation

All rights reserved.

File Name:

    pshndlr.h

Abstract:

    Base PrintSchema Document handler class definition.
    This class provides common PrintTicket / PrintCapabilities handling functionality.
    A class can derive from this base class to get PrintTicket/PrintCapabilities
    unspecific XML handling functionality.

    Note: The PrintSchema handler code is only intended to work with the sdtandard
    public PrintSchema keywords.

--*/

#pragma once

#include "schema.h"

typedef vector< CComPtr<IXMLDOMElement> > PTDOMElementVector;

class CPSHandler
{
public:
    //
    // Constructors and destructors
    //
    CPSHandler(
        _In_z_ BSTR bstrDocumentType,
        _In_ IXMLDOMDocument2 *pPrintDocument
        );

    virtual ~CPSHandler();

public:
    HRESULT
    DeleteNode(
        _In_ IXMLDOMNode* pNode
        );

    HRESULT
    DeletePrivateFeatures(
        _In_z_ BSTR bstrPrivateNS
        );

protected:
    HRESULT
    QueryNode(
        _In_z_ BSTR  bstrQuery
        );

    HRESULT
    QueryNodeValue(
        _In_z_      BSTR  bstrQuery,
        _Outptr_ BSTR* pbstrValue
        );

    HRESULT
    QueryNodeValue(
        _In_z_ BSTR  bstrQuery,
        _Out_  REAL* pValue
        );

    HRESULT
    QueryNodeValue(
        _In_z_ BSTR  bstrQuery,
        _Out_  INT* pValue
        );

    HRESULT
    GetNodeValue(
        _In_z_      BSTR  bstrNodeQuery,
        _Inout_ _At_(*pbstrValue, _Pre_maybenull_)
        _When_(return == S_FALSE, _At_(*pbstrValue, _Post_maybenull_))
        _When_(return != S_FALSE, _At_(*pbstrValue, _Post_valid_))
                    BSTR* pbstrValue
        );

    HRESULT
    GetAttributeValue(
        _In_            CONST IXMLDOMNode* pNode,
        _In_z_          BSTR               bstrAttribName,
        _Outptr_result_maybenull_ BSTR*              pbstrResult
        );

    HRESULT
    GetNodes(
        _In_        BSTR              bstrElementName,
        _Outptr_ IXMLDOMNodeList** ppNodeList
        );

    HRESULT
    CreateProperty(
        _In_        CONST BSTR       bstrPropName,
        _Outptr_ IXMLDOMElement** ppPropElement
        );

    HRESULT
    CreateProperty(
        _In_        CONST BSTR       bstrPropName,
        _In_        CONST BSTR       bstrType,
        _In_        CONST BSTR       bstrValue,
        _Outptr_ IXMLDOMElement** ppPropElement
        );

    HRESULT
    CreateFWProperty(
        _In_        CONST BSTR       bstrPropName,
        _Outptr_ IXMLDOMElement** ppPropElement
        );

    HRESULT
    CreateFWProperty(
        _In_        CONST BSTR       bstrPropName,
        _In_        CONST BSTR       bstrType,
        _In_        CONST BSTR       bstrValue,
        _Outptr_ IXMLDOMElement** ppPropElement
        );

    HRESULT
    CreateScoredProperty(
        _In_        CONST BSTR       bstrPropName,
        _Outptr_ IXMLDOMElement** ppScoredPropElement
        );

    HRESULT
    CreateScoredProperty(
        _In_        CONST BSTR       bstrPropName,
        _In_        CONST BSTR       bstrType,
        _In_        CONST BSTR       bstrValue,
        _Outptr_ IXMLDOMElement** ppScoredPropElement
        );

    HRESULT
    CreateScoredProperty(
        _In_        CONST BSTR       bstrPropName,
        _In_        CONST BSTR       bstrValue,
        _Outptr_ IXMLDOMElement** ppScoredPropElement
        );

    HRESULT
    CreateScoredProperty(
        _In_        CONST BSTR       bstrPropName,
        _In_        CONST INT        intValue,
        _Outptr_ IXMLDOMElement** ppScoredPropElement
        );

    HRESULT
    CreateScoredProperty(
        _In_        CONST BSTR       bstrPropName,
        _In_        CONST REAL       realValue,
        _Outptr_ IXMLDOMElement** ppScoredPropElement
        );

    HRESULT
    CreateScoredProperty(
        _In_        CONST BSTR       bstrPropName,
        _In_        IXMLDOMNode*     pValueNode,
        _Outptr_ IXMLDOMElement** ppScoredPropElement
        );

    HRESULT
    GetNode(
    _In_z_      BSTR          bstrNodeQuery,
    _Outptr_ IXMLDOMNode** ppNode
    );

    HRESULT
    CreateXMLAttribute(
        _Inout_    IXMLDOMElement *pTarget,
        _In_       PCWSTR pszName,
        _In_opt_   PCWSTR pszTargetURI,
        _In_       PCWSTR pszValue
    );

    HRESULT
    CreateXMLElement(
        _In_       PCWSTR pszName,
        _In_       PCWSTR pszTargetURI,
        _Out_opt_  IXMLDOMElement **ppEl
    );

private:

    HRESULT
    GetPrefixFromURI(
        _In_z_                    BSTR  bstrNSURI,
        _Outptr_result_maybenull_ BSTR* bstrNSPrefix
        );

protected:
    //
    // Document and Type
    //
    CComPtr<IXMLDOMDocument2> m_pPrintDocument;
    CComBSTR    m_bstrDocumentType;

    //
    // W3 namespace prefixes
    //
    CComBSTR    m_bstrSchemaPrefix;
    CComBSTR    m_bstrSchemaInstPrefix;

    //
    // Namespace abbreviations
    //
    CComBSTR    m_bstrFrameworkPrefix;
    CComBSTR    m_bstrKeywordsPrefix;
    CComBSTR    m_bstrUserKeywordsPrefix;
};