JX Application Framework
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | List of all members
JXPTPrinter Class Reference

#include <JXPTPrinter.h>

Inheritance diagram for JXPTPrinter:
[legend]

Public Types

enum  Destination {
  kPrintToPrinter = 0 ,
  kPrintToFile = 1
}
 

Public Member Functions

 JXPTPrinter ()
 
 ~JXPTPrinter () override
 
void Print (const JString &text) override
 
void ReadXPTSetup (std::istream &input)
 
void WriteXPTSetup (std::ostream &output) const
 
Destination GetDestination () const
 
void SetDestination (const Destination dest, const JString &printCmd, const JString &fileName)
 
const JStringGetPrintCmd () const
 
void SetPrintCmd (const JString &cmd)
 
const JStringGetFileName () const
 
void SetFileName (const JString &name)
 
bool EditUserPageSetup ()
 
bool ConfirmUserPrintSetup ()
 
- Public Member Functions inherited from JPTPrinter
 JPTPrinter ()
 
 ~JPTPrinter () override
 
void ReadPTSetup (std::istream &input)
 
void WritePTSetup (std::ostream &output) const
 
JSize GetCopyCount () const
 
void SetCopyCount (const JSize count)
 
JIndex GetFirstPageToPrint () const
 
void SetFirstPageToPrint (const JIndex index)
 
JIndex GetLastPageToPrint () const
 
void SetLastPageToPrint (const JIndex index)
 
bool WillPrintAllPages () const
 
void PrintAllPages ()
 
bool WillPrintReverseOrder () const
 
void ShouldPrintReverseOrder (const bool reverse)
 
bool WillPrintLineNumbers () const
 
void ShouldPrintLineNumbers (const bool print)
 
JSize GetPageWidth () const
 
void SetPageWidth (const JSize width)
 
JSize GetPageHeight () const
 
void SetPageHeight (const JSize height)
 
JSize GetTabWidth () const
 
void SetTabWidth (const JSize width)
 
- Public Member Functions inherited from JPrinter
 JPrinter ()
 
 ~JPrinter () override
 
- Public Member Functions inherited from JBroadcaster
 JBroadcaster ()
 
virtual ~JBroadcaster ()
 
JBroadcasteroperator= (const JBroadcaster &source)
 
bool HasSenders () const
 
JSize GetSenderCount () const
 
bool HasRecipients () const
 
JSize GetRecipientCount () const
 
virtual JString ToString () const
 
template<class T >
void ListenTo (const JBroadcaster *sender, const std::function< void(const T &)> &f)
 

Protected Member Functions

virtual JXPTPageSetupDialogCreatePageSetupDialog (const JString &printCmd, const JSize pageWidth, const JSize pageHeight, const JSize minPageHeight, const bool printReverseOrder)
 
virtual JXPTPrintSetupDialogCreatePrintSetupDialog (const Destination destination, const JString &printCmd, const JString &fileName, const bool printLineNumbers)
 
- Protected Member Functions inherited from JPTPrinter
bool Print (const JString &text, std::ostream &output)
 
virtual JSize GetHeaderLineCount () const
 
virtual JSize GetFooterLineCount () const
 
virtual void PrintHeader (std::ostream &output, const JIndex pageIndex)
 
virtual void PrintFooter (std::ostream &output, const JIndex pageIndex)
 
- Protected Member Functions inherited from JBroadcaster
 JBroadcaster (const JBroadcaster &source)
 
void ListenTo (const JBroadcaster *sender)
 
void StopListening (const JBroadcaster *sender)
 
void ClearWhenGoingAway (const JBroadcaster *sender, void *pointerToMember)
 
void StopListening (const JBroadcaster *sender, const std::type_info &messageType)
 
template<class T >
void Send (JBroadcaster *recipient, const T &message)
 
template<class T >
void Broadcast (const T &message)
 
virtual void Receive (JBroadcaster *sender, const Message &message)
 
void SendWithFeedback (JBroadcaster *recipient, Message *message)
 
void BroadcastWithFeedback (Message *message)
 
virtual void ReceiveWithFeedback (JBroadcaster *sender, Message *message)
 
virtual void ReceiveGoingAway (JBroadcaster *sender)
 

Detailed Description

This class implements the functions required to print plain text.

Member Enumeration Documentation

◆ Destination

Enumerator
kPrintToPrinter 
kPrintToFile 

Constructor & Destructor Documentation

◆ JXPTPrinter()

JXPTPrinter::JXPTPrinter ( )

◆ ~JXPTPrinter()

JXPTPrinter::~JXPTPrinter ( )
override

Member Function Documentation

◆ ConfirmUserPrintSetup()

bool JXPTPrinter::ConfirmUserPrintSetup ( )

Displays a dialog with print setup information. Returns true if the user confirms printing.

◆ CreatePageSetupDialog()

JXPTPageSetupDialog * JXPTPrinter::CreatePageSetupDialog ( const JString printCmd,
const JSize  pageWidth,
const JSize  pageHeight,
const JSize  minPageHeight,
const bool  printReverseOrder 
)
protectedvirtual

Derived class can override to create an extended dialog.

◆ CreatePrintSetupDialog()

JXPTPrintSetupDialog * JXPTPrinter::CreatePrintSetupDialog ( const Destination  destination,
const JString printCmd,
const JString fileName,
const bool  printLineNumbers 
)
protectedvirtual

Derived class can override to create an extended dialog.

◆ EditUserPageSetup()

bool JXPTPrinter::EditUserPageSetup ( )

Displays a dialog with page setup information. Returns true if the setup changed.

◆ GetDestination()

JXPTPrinter::Destination JXPTPrinter::GetDestination ( ) const
inline

◆ GetFileName()

const JString & JXPTPrinter::GetFileName ( ) const
inline

◆ GetPrintCmd()

const JString & JXPTPrinter::GetPrintCmd ( ) const
inline

◆ Print()

void JXPTPrinter::Print ( const JString text)
overridevirtual

Implements JPTPrinter.

◆ ReadXPTSetup()

void JXPTPrinter::ReadXPTSetup ( std::istream &  input)

Automatically calls ReadPTSetup().

◆ SetDestination()

void JXPTPrinter::SetDestination ( const Destination  dest,
const JString printCmd,
const JString fileName 
)

cmd and fileName can be empty. They are there to force the caller to consider them.

◆ SetFileName()

void JXPTPrinter::SetFileName ( const JString name)

◆ SetPrintCmd()

void JXPTPrinter::SetPrintCmd ( const JString cmd)

◆ WriteXPTSetup()

void JXPTPrinter::WriteXPTSetup ( std::ostream &  output) const

Automatically calls WritePTSetup().


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