Harlinn::Windows::Graphics::PrintControl Class Reference

Converts Direct2D primitives stored in an ID2D1CommandList into a fixed page representation. The print sub-system then consumes the primitives. More...

#include <HWGraphics.h>

Inheritance diagram for Harlinn::Windows::Graphics::PrintControl:

Collaboration diagram for Harlinn::Windows::Graphics::PrintControl:

Public Types
using	Base = Unknown
Public Types inherited from Harlinn::Common::Core::Unknown
typedef IUnknown	InterfaceType

Public Member Functions
void	AddPage (ID2D1CommandList *commandList, D2D_SIZE_F pageSize, IStream *pagePrintTicketStream, D2D1_TAG *tag1=nullptr, D2D1_TAG *tag2=nullptr) const
	Converts Direct2D primitives in the passed-in command list into a fixed page representation for use by the print subsystem.
void	AddPage (const CommandList &commandList, D2D_SIZE_F pageSize, IStream *pagePrintTicketStream, D2D1_TAG *tag1=nullptr, D2D1_TAG *tag2=nullptr) const
void	AddPage (const CommandList &commandList, D2D_SIZE_F pageSize, const hcc::Stream &pagePrintTicketStream, D2D1_TAG *tag1=nullptr, D2D1_TAG *tag2=nullptr) const
void	Close () const
	Passes all remaining resources to the print sub-system, then clean up and close the current print job.
Public Member Functions inherited from Harlinn::Common::Core::Unknown
constexpr	Unknown () noexcept
	Unknown (IUnknown *unknown, bool addref=false) noexcept
	Unknown (REFIID iid, const Unknown &unknown, bool throwIfNoInterface=true)
	Unknown (const Unknown &other) noexcept
	Unknown (Unknown &&other) noexcept
	~Unknown () noexcept
constexpr	operator bool () const noexcept
Unknown &	operator= (const Unknown &other) noexcept
Unknown &	operator= (Unknown &&other) noexcept
void	swap (Unknown &other) noexcept
void	ResetPtr (IUnknown *other=nullptr, bool addRef=false) noexcept
Unknown &	operator= (nullptr_t)
IUnknown *	Detach ()
template<typename T > requires std::is_base_of_v<Unknown, T >
T	As () const
template<typename T > requires std::is_base_of_v<Unknown, T>
bool	Is () const noexcept
template<typename T > requires std::is_base_of_v<IUnknown, T>
ComPtr< T >	As () const
template<typename T > requires std::is_base_of_v<IUnknown, T>
bool	Is () const noexcept
	This function can be used to detect if an object supports a particular COM interface derived from IUnknown.
template<typename T = IUnknown>
T *	GetInterfacePointer () const noexcept
bool	QueryInterface (REFIID riid, void **itf) const
	Queries a COM object for a pointer to one of its interface; identifying the interface by a reference to its interface identifier (IID). If the COM object implements the interface, then it returns a pointer to that interface after calling IUnknown::AddRef on it.
template<typename T > requires std::is_base_of_v<IUnknown, T>
bool	QueryInterface (T **itf) const
constexpr bool	operator== (const Unknown &other) const noexcept
constexpr bool	operator!= (const Unknown &other) const noexcept
constexpr bool	operator== (const IUnknown *other) const noexcept
constexpr bool	operator!= (const IUnknown *other) const noexcept

Additional Inherited Members
Static Public Member Functions inherited from Harlinn::Common::Core::Unknown
template<typename T > requires std::is_base_of_v<Unknown, T>
static T	CoCreateInstanceFromClassId (const CLSID &clsid, DWORD classContext=CLSCTX_INPROC_SERVER)
template<typename T > requires std::is_base_of_v<Unknown, T>
static T	CoCreateInstanceFromClassId (const wchar_t *clsid, DWORD classContext=CLSCTX_INPROC_SERVER)
template<typename T > requires std::is_base_of_v<Unknown, T>
static T	CoCreateInstanceFromClassId (const WideString &clsid, DWORD classContext=CLSCTX_INPROC_SERVER)
template<typename T > requires std::is_base_of_v<Unknown, T>
static T	CoCreateInstanceFromProgId (const wchar_t *progId, DWORD classContext=CLSCTX_INPROC_SERVER)
template<typename T > requires std::is_base_of_v<Unknown, T>
static T	CoCreateInstanceFromProgId (const WideString &progId, DWORD classContext=CLSCTX_INPROC_SERVER)
template<typename T > requires std::is_base_of_v<Unknown, T>
static T	CoCreateInstanceFromDll (const ModuleHandle &dll, const CLSID &clsid)
Protected Attributes inherited from Harlinn::Common::Core::Unknown
IUnknown *	unknown_

Detailed Description

Converts Direct2D primitives stored in an ID2D1CommandList into a fixed page representation. The print sub-system then consumes the primitives.

Member Typedef Documentation

Base

using Harlinn::Windows::Graphics::PrintControl::Base = Unknown

Member Function Documentation

AddPage() [1/3]

void Harlinn::Windows::Graphics::PrintControl::AddPage ( const CommandList & commandList, D2D_SIZE_F pageSize, const hcc::Stream & pagePrintTicketStream, D2D1_TAG * tag1 = nullptr, D2D1_TAG * tag2 = nullptr ) const

inline

AddPage() [2/3]

void Harlinn::Windows::Graphics::PrintControl::AddPage ( const CommandList & commandList, D2D_SIZE_F pageSize, IStream * pagePrintTicketStream, D2D1_TAG * tag1 = nullptr, D2D1_TAG * tag2 = nullptr ) const

inline

AddPage() [3/3]

void Harlinn::Windows::Graphics::PrintControl::AddPage ( ID2D1CommandList * commandList, D2D_SIZE_F pageSize, IStream * pagePrintTicketStream, D2D1_TAG * tag1 = nullptr, D2D1_TAG * tag2 = nullptr ) const

inline

Converts Direct2D primitives in the passed-in command list into a fixed page representation for use by the print subsystem.

Parameters

commandList	The command list that contains the rendering operations.
pageSize	The size of the page to add.
pagePrintTicketStream	The print ticket stream.
tag1	Contains the first label for subsequent drawing operations. This parameter is passed uninitialized. If nullptr is specified, no value is retrieved for this parameter.
tag2	Contains the second label for subsequent drawing operations. This parameter is passed uninitialized. If nullptr is specified, no value is retrieved for this parameter.

Close()

void Harlinn::Windows::Graphics::PrintControl::Close ( ) const

inline

Passes all remaining resources to the print sub-system, then clean up and close the current print job.

---

The documentation for this class was generated from the following file:

• HWGraphics.h