JX Application Framework
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
JEPSPrinter Class Referenceabstract

#include <JEPSPrinter.h>

Inheritance diagram for JEPSPrinter:
[legend]

Public Member Functions

 JEPSPrinter (JFontManager *fontManager)
 
 ~JEPSPrinter () override
 
void ReadEPSSetup (std::istream &input)
 
void WriteEPSSetup (std::ostream &output) const
 
bool OpenDocument (const JRect &bounds)
 
void CloseDocument ()
 
bool WantsPreview () const
 
void ShouldPrintPreview (const bool doIt)
 
virtual JPainterGetPreviewPainter (const JRect &bounds)=0
 
JRect GetBounds () const
 
JRect SetClipRect (const JRect &r) override
 
void SetDashList (const JArray< JSize > &dashList, const JSize dashOffset=0) override
 
void StringNoSubstitutions (const JCoordinate left, const JCoordinate top, const JString &str) override
 
void String (const JFloat angle, const JCoordinate left, const JCoordinate top, const JString &str, const JCoordinate width=0, const HAlign hAlign=HAlign::kLeft, const JCoordinate height=0, const VAlign vAlign=VAlign::kTop) override
 
void Point (const JCoordinate x, const JCoordinate y) override
 
void Line (const JCoordinate x1, const JCoordinate y1, const JCoordinate x2, const JCoordinate y2) override
 
void Rect (const JCoordinate x, const JCoordinate y, const JCoordinate w, const JCoordinate h) override
 
void Ellipse (const JCoordinate x, const JCoordinate y, const JCoordinate w, const JCoordinate h) override
 
void Arc (const JCoordinate x, const JCoordinate y, const JCoordinate w, const JCoordinate h, const JFloat startAngle, const JFloat deltaAngle) override
 
void Polygon (const JCoordinate left, const JCoordinate top, const JPolygon &poly) override
 
void Image (const JImage &image, const JRect &srcRect, const JRect &destRect) override
 
void String (const JCoordinate left, const JCoordinate top, const JString &str, const JCoordinate width=0, const HAlign hAlign=HAlign::kLeft, const JCoordinate height=0, const VAlign vAlign=VAlign::kTop)
 
void String (const JPoint &topLeft, const JString &str, const JCoordinate width=0, const HAlign hAlign=HAlign::kLeft, const JCoordinate height=0, const VAlign vAlign=VAlign::kTop)
 
void String (const JRect &rect, const JString &str, const HAlign hAlign=HAlign::kLeft, const VAlign vAlign=VAlign::kTop)
 
virtual void String (const JFloat angle, const JCoordinate left, const JCoordinate top, const JString &str, const JCoordinate width=0, const HAlign hAlign=HAlign::kLeft, const JCoordinate height=0, const VAlign vAlign=VAlign::kTop)=0
 
void String (const JFloat angle, const JPoint &topLeft, const JString &str, const JCoordinate width=0, const HAlign hAlign=HAlign::kLeft, const JCoordinate height=0, const VAlign vAlign=VAlign::kTop)
 
void String (const JFloat angle, const JRect &rect, const JString &str, const HAlign hAlign=HAlign::kLeft, const VAlign vAlign=VAlign::kTop)
 
virtual void Point (const JCoordinate x, const JCoordinate y)=0
 
void Point (const JPoint &pt)
 
virtual void Line (const JCoordinate x1, const JCoordinate y1, const JCoordinate x2, const JCoordinate y2)=0
 
void Line (const JPoint &pt1, const JPoint &pt2)
 
virtual void Rect (const JCoordinate x, const JCoordinate y, const JCoordinate w, const JCoordinate h)=0
 
void Rect (const JPoint &upperLeft, const JCoordinate w, const JCoordinate h)
 
void Rect (const JRect &bounds)
 
virtual void Ellipse (const JCoordinate x, const JCoordinate y, const JCoordinate w, const JCoordinate h)=0
 
void Ellipse (const JPoint &upperLeft, const JCoordinate w, const JCoordinate h)
 
void Ellipse (const JRect &bounds)
 
virtual void Arc (const JCoordinate x, const JCoordinate y, const JCoordinate w, const JCoordinate h, const JFloat startAngle, const JFloat deltaAngle)=0
 
void Arc (const JPoint &upperLeft, const JCoordinate w, const JCoordinate h, const JFloat startAngle, const JFloat deltaAngle)
 
void Arc (const JRect &bounds, const JFloat startAngle, const JFloat deltaAngle)
 
virtual void Polygon (const JCoordinate left, const JCoordinate top, const JPolygon &poly)=0
 
void Polygon (const JPoint &upperLeft, const JPolygon &poly)
 
void Polygon (const JPolygon &poly)
 
void Image (const JImage &image, const JRect &srcRect, const JCoordinate left, const JCoordinate top)
 
void Image (const JImage &image, const JRect &srcRect, const JPoint &topLeft)
 
virtual void Image (const JImage &image, const JRect &srcRect, const JRect &destRect)=0
 
- Public Member Functions inherited from JPainter
 JPainter (JFontManager *fontManager, const JRect &defaultClipRect)
 
virtual ~JPainter ()
 
JFontManagerGetFontManager () const
 
virtual void Reset ()
 
void Reset (const JRect &defClipRect)
 
virtual void ResetAllButClipping ()
 
const JRectGetClipRect () const
 
void ResetClipRect ()
 
const JRectGetDefaultClipRect () const
 
void SetDefaultClipRect (const JRect &r)
 
const JPointGetOrigin () const
 
void SetOrigin (const JCoordinate x, const JCoordinate y)
 
void SetOrigin (const JPoint &pt)
 
void ShiftOrigin (const JCoordinate dx, const JCoordinate dy)
 
void ShiftOrigin (const JPoint &delta)
 
const JPointGetPenLocation () const
 
void SetPenLocation (const JCoordinate x, const JCoordinate y)
 
void SetPenLocation (const JPoint &pt)
 
void ShiftPenLocation (const JCoordinate dx, const JCoordinate dy)
 
void ShiftPenLocation (const JPoint &delta)
 
JColorID GetPenColor () const
 
void SetPenColor (const JColorID color)
 
JSize GetLineWidth () const
 
void SetLineWidth (const JSize width)
 
bool LinesAreDashed () const
 
void DrawDashedLines (const bool on)
 
bool GetDashList (const JArray< JSize > **dashList, JSize *dashOffset) const
 
bool IsFilling () const
 
void SetFilling (const bool on)
 
const JFontGetFont () const
 
void SetFontName (const JString &name)
 
void SetFontSize (const JSize size)
 
void SetFontStyle (const JFontStyle &style)
 
void SetFont (const JFont &f)
 
JSize GetLineHeight (JCoordinate *ascent, JCoordinate *descent) const
 
JSize GetLineHeight () const
 
JSize GetStringWidth (const JString &str) const
 
void String (const JCoordinate left, const JCoordinate top, const JString &str, const JCoordinate width=0, const HAlign hAlign=HAlign::kLeft, const JCoordinate height=0, const VAlign vAlign=VAlign::kTop)
 
void String (const JPoint &topLeft, const JString &str, const JCoordinate width=0, const HAlign hAlign=HAlign::kLeft, const JCoordinate height=0, const VAlign vAlign=VAlign::kTop)
 
void String (const JRect &rect, const JString &str, const HAlign hAlign=HAlign::kLeft, const VAlign vAlign=VAlign::kTop)
 
void String (const JFloat angle, const JPoint &topLeft, const JString &str, const JCoordinate width=0, const HAlign hAlign=HAlign::kLeft, const JCoordinate height=0, const VAlign vAlign=VAlign::kTop)
 
void String (const JFloat angle, const JRect &rect, const JString &str, const HAlign hAlign=HAlign::kLeft, const VAlign vAlign=VAlign::kTop)
 
void Point (const JPoint &pt)
 
void Line (const JPoint &pt1, const JPoint &pt2)
 
void LineTo (const JCoordinate x, const JCoordinate y)
 
void LineTo (const JPoint &pt)
 
void DeltaLine (const JCoordinate dx, const JCoordinate dy)
 
void DeltaLine (const JPoint &delta)
 
void Rect (const JPoint &upperLeft, const JCoordinate w, const JCoordinate h)
 
void Rect (const JRect &bounds)
 
void RectInside (const JRect &bounds)
 
void Ellipse (const JPoint &upperLeft, const JCoordinate w, const JCoordinate h)
 
void Ellipse (const JRect &bounds)
 
void Arc (const JPoint &upperLeft, const JCoordinate w, const JCoordinate h, const JFloat startAngle, const JFloat deltaAngle)
 
void Arc (const JRect &bounds, const JFloat startAngle, const JFloat deltaAngle)
 
void Polygon (const JPoint &upperLeft, const JPolygon &poly)
 
void Polygon (const JPolygon &poly)
 
void Image (const JImage &image, const JRect &srcRect, const JCoordinate left, const JCoordinate top)
 
void Image (const JImage &image, const JRect &srcRect, const JPoint &topLeft)
 
- 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)
 
- Public Member Functions inherited from JPSPrinterBase
 JPSPrinterBase (JFontManager *fontManager)
 
virtual ~JPSPrinterBase ()
 
void SetCreator (const JString &str)
 
void SetTitle (const JString &str)
 
bool PSOpenDocument ()
 
void PSCloseDocument ()
 
void PSCancelDocument ()
 
bool PSDocumentIsOpen () const
 
const JStringGetOutputFileName () const
 
void SetOutputFileName (const JString &name)
 
bool PSWillPrintBlackWhite () const
 
void PSPrintBlackWhite (const bool doIt)
 
void PSSetClipRect (const JRect &r)
 
void PSSetDashList (const JArray< JSize > &dashList, const JSize dashOffset=0)
 
void PSString (const JFont &font, const JCoordinate ascent, const JCoordinate aligndx, const JCoordinate aligndy, const JFloat angle, const JCoordinate left, const JCoordinate top, const JString &str)
 
void PSLine (const JCoordinate x1, const JCoordinate y1, const JCoordinate x2, const JCoordinate y2, const JColorID color, const JSize lineWidth, const bool drawDashedLines)
 
void PSRect (const JCoordinate x, const JCoordinate y, const JCoordinate w, const JCoordinate h, const JColorID color, const JSize lineWidth, const bool drawDashedLines, const bool fill)
 
void PSArc (const JCoordinate x, const JCoordinate y, const JCoordinate w, const JCoordinate h, const JFloat startAngle, const JFloat deltaAngle, const JColorID color, const JSize lineWidth, const bool drawDashedLines, const bool fill)
 
void PSPolygon (const JCoordinate left, const JCoordinate top, const JPolygon &poly, const JColorID color, const JSize lineWidth, const bool drawDashedLines, const bool fill)
 
void PSColorImage (const JImage &image, const JRect &srcRect, const JRect &destRect)
 

Protected Member Functions

virtual bool GetPreviewImage (const JImage **image) const =0
 
virtual void DeletePreviewData ()=0
 
const JPointPSGetOrigin () const override
 
void PSResetCoordinates () override
 
JCoordinate PSGetPrintableHeight () const override
 
bool PSShouldPrintCurrentPage () const override
 
void PSPrintVersionComment (std::ostream &output) override
 
void PSPrintHeaderComments (std::ostream &output) override
 
void PSPrintSetupComments (std::ostream &output) override
 
- Protected Member Functions inherited from JPainter
JSize AlignString (JCoordinate *left, JCoordinate *top, const JString &str, const JCoordinate width, const HAlign hAlign, const JCoordinate height, const VAlign vAlign) const
 
- 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)
 
- Protected Member Functions inherited from JPSPrinterBase
std::ostream & GetOutputStream ()
 
void PSSaveGraphicsState ()
 
void PSRestoreGraphicsState ()
 
JPoint ConvertToPS (const JCoordinate x, const JCoordinate y) const
 
JPoint ConvertToPS (const JPoint &pt) const
 
void PSConvertToRGB (const JColorID color, JSize *red, JSize *green, JSize *blue) const
 

Additional Inherited Members

- Public Types inherited from JPainter
enum struct  HAlign {
  kLeft ,
  kCenter ,
  kRight
}
 
enum struct  VAlign {
  kTop ,
  kCenter ,
  kBottom
}
 
- Static Public Attributes inherited from JPSPrinterBase
static const JCoordinate kPixelsPerInch = 72
 

Detailed Description

Interface for the JEPSPrinter class

This class implements the functions required to draw to an
Encapsulated PostScript file.

Clients are required to check WantsPreview() before calling
OpenDocument().  If this returns true, they should call
GetPreviewPainter() and draw to the resulting JPainter.
OpenDocument() then prints the preview automatically.

Derived classes must implement the following functions:

    GetPreviewPainter
        Create an image, create a painter for it, set the coordinates
        to match the bounds passed to OpenDocument(), and return
        the painter.

    GetPreviewImage
        Return the preview image, if any.

    DeletePreviewData
        Delete the image and painter created in GetPreviewPainter().
        This is only called if GetPreviewImage() returns true;

Constructor & Destructor Documentation

◆ JEPSPrinter()

JEPSPrinter::JEPSPrinter ( JFontManager fontManager)

We set the default clip rect in OpenDocument().

◆ ~JEPSPrinter()

JEPSPrinter::~JEPSPrinter ( )
override

Member Function Documentation

◆ Arc() [1/4]

void JEPSPrinter::Arc ( const JCoordinate  x,
const JCoordinate  y,
const JCoordinate  w,
const JCoordinate  h,
const JFloat  startAngle,
const JFloat  deltaAngle 
)
overridevirtual

Implements JPainter.

◆ Arc() [2/4]

virtual void JPainter::Arc ( const JCoordinate  x,
const JCoordinate  y,
const JCoordinate  w,
const JCoordinate  h,
const JFloat  startAngle,
const JFloat  deltaAngle 
)
virtual

Implements JPainter.

◆ Arc() [3/4]

void JPainter::Arc ( const JPoint upperLeft,
const JCoordinate  w,
const JCoordinate  h,
const JFloat  startAngle,
const JFloat  deltaAngle 
)
inline

◆ Arc() [4/4]

void JPainter::Arc ( const JRect bounds,
const JFloat  startAngle,
const JFloat  deltaAngle 
)
inline

◆ CloseDocument()

void JEPSPrinter::CloseDocument ( )

◆ DeletePreviewData()

virtual void JEPSPrinter::DeletePreviewData ( )
protectedpure virtual

Implemented in JXEPSPrinter.

◆ Ellipse() [1/4]

void JEPSPrinter::Ellipse ( const JCoordinate  x,
const JCoordinate  y,
const JCoordinate  w,
const JCoordinate  h 
)
overridevirtual

Implements JPainter.

◆ Ellipse() [2/4]

virtual void JPainter::Ellipse ( const JCoordinate  x,
const JCoordinate  y,
const JCoordinate  w,
const JCoordinate  h 
)
virtual

Implements JPainter.

◆ Ellipse() [3/4]

void JPainter::Ellipse ( const JPoint upperLeft,
const JCoordinate  w,
const JCoordinate  h 
)
inline

◆ Ellipse() [4/4]

void JPainter::Ellipse ( const JRect bounds)
inline

◆ GetBounds()

JRect JEPSPrinter::GetBounds ( ) const
inline

◆ GetPreviewImage()

virtual bool JEPSPrinter::GetPreviewImage ( const JImage **  image) const
protectedpure virtual

Implemented in JXEPSPrinter.

◆ GetPreviewPainter()

virtual JPainter & JEPSPrinter::GetPreviewPainter ( const JRect bounds)
pure virtual

Implemented in JXEPSPrinter.

◆ Image() [1/4]

void JPainter::Image ( const JImage image,
const JRect srcRect,
const JCoordinate  left,
const JCoordinate  top 
)
inline

◆ Image() [2/4]

void JPainter::Image ( const JImage image,
const JRect srcRect,
const JPoint topLeft 
)
inline

◆ Image() [3/4]

void JEPSPrinter::Image ( const JImage image,
const JRect srcRect,
const JRect destRect 
)
overridevirtual

Implements JPainter.

◆ Image() [4/4]

virtual void JPainter::Image ( const JImage image,
const JRect srcRect,
const JRect destRect 
)
virtual

Implements JPainter.

◆ Line() [1/3]

void JEPSPrinter::Line ( const JCoordinate  x1,
const JCoordinate  y1,
const JCoordinate  x2,
const JCoordinate  y2 
)
overridevirtual

Implements JPainter.

◆ Line() [2/3]

virtual void JPainter::Line ( const JCoordinate  x1,
const JCoordinate  y1,
const JCoordinate  x2,
const JCoordinate  y2 
)
virtual

Implements JPainter.

◆ Line() [3/3]

void JPainter::Line ( const JPoint pt1,
const JPoint pt2 
)
inline

◆ OpenDocument()

bool JEPSPrinter::OpenDocument ( const JRect bounds)

◆ Point() [1/3]

void JEPSPrinter::Point ( const JCoordinate  x,
const JCoordinate  y 
)
overridevirtual

Implements JPainter.

◆ Point() [2/3]

virtual void JPainter::Point ( const JCoordinate  x,
const JCoordinate  y 
)
virtual

Implements JPainter.

◆ Point() [3/3]

void JPainter::Point ( const JPoint pt)
inline

◆ Polygon() [1/4]

void JEPSPrinter::Polygon ( const JCoordinate  left,
const JCoordinate  top,
const JPolygon poly 
)
overridevirtual

Implements JPainter.

◆ Polygon() [2/4]

virtual void JPainter::Polygon ( const JCoordinate  left,
const JCoordinate  top,
const JPolygon poly 
)
virtual

Implements JPainter.

◆ Polygon() [3/4]

void JPainter::Polygon ( const JPoint upperLeft,
const JPolygon poly 
)
inline

◆ Polygon() [4/4]

void JPainter::Polygon ( const JPolygon poly)
inline

◆ PSGetOrigin()

const JPoint & JEPSPrinter::PSGetOrigin ( ) const
overrideprotectedvirtual

Implements JPSPrinterBase.

◆ PSGetPrintableHeight()

JCoordinate JEPSPrinter::PSGetPrintableHeight ( ) const
overrideprotectedvirtual

Implements JPSPrinterBase.

◆ PSPrintHeaderComments()

void JEPSPrinter::PSPrintHeaderComments ( std::ostream &  output)
overrideprotectedvirtual

Implements JPSPrinterBase.

◆ PSPrintSetupComments()

void JEPSPrinter::PSPrintSetupComments ( std::ostream &  output)
overrideprotectedvirtual

Implements JPSPrinterBase.

◆ PSPrintVersionComment()

void JEPSPrinter::PSPrintVersionComment ( std::ostream &  output)
overrideprotectedvirtual

Implements JPSPrinterBase.

◆ PSResetCoordinates()

void JEPSPrinter::PSResetCoordinates ( )
overrideprotectedvirtual

Implements JPSPrinterBase.

◆ PSShouldPrintCurrentPage()

bool JEPSPrinter::PSShouldPrintCurrentPage ( ) const
overrideprotectedvirtual

Implements JPSPrinterBase.

◆ ReadEPSSetup()

void JEPSPrinter::ReadEPSSetup ( std::istream &  input)

◆ Rect() [1/4]

void JEPSPrinter::Rect ( const JCoordinate  x,
const JCoordinate  y,
const JCoordinate  w,
const JCoordinate  h 
)
overridevirtual

Implements JPainter.

◆ Rect() [2/4]

virtual void JPainter::Rect ( const JCoordinate  x,
const JCoordinate  y,
const JCoordinate  w,
const JCoordinate  h 
)
virtual

Implements JPainter.

◆ Rect() [3/4]

void JPainter::Rect ( const JPoint upperLeft,
const JCoordinate  w,
const JCoordinate  h 
)
inline

◆ Rect() [4/4]

void JPainter::Rect ( const JRect bounds)
inline

◆ SetClipRect()

JRect JEPSPrinter::SetClipRect ( const JRect r)
overridevirtual

Reimplemented from JPainter.

◆ SetDashList()

void JEPSPrinter::SetDashList ( const JArray< JSize > &  dashList,
const JSize  dashOffset = 0 
)
overridevirtual

Reimplemented from JPainter.

◆ ShouldPrintPreview()

void JEPSPrinter::ShouldPrintPreview ( const bool  doIt)
inline

◆ String() [1/7]

void JPainter::String ( const JCoordinate  left,
const JCoordinate  top,
const JString str,
const JCoordinate  width = 0,
const HAlign  hAlign = HAlign::kLeft,
const JCoordinate  height = 0,
const VAlign  vAlign = VAlign::kTop 
)

◆ String() [2/7]

void JEPSPrinter::String ( const JFloat  angle,
const JCoordinate  left,
const JCoordinate  top,
const JString str,
const JCoordinate  width = 0,
const HAlign  hAlign = HAlign::kLeft,
const JCoordinate  height = 0,
const VAlign  vAlign = VAlign::kTop 
)
overridevirtual

Implements JPainter.

◆ String() [3/7]

virtual void JPainter::String ( const JFloat  angle,
const JCoordinate  left,
const JCoordinate  top,
const JString str,
const JCoordinate  width = 0,
const HAlign  hAlign = HAlign::kLeft,
const JCoordinate  height = 0,
const VAlign  vAlign = VAlign::kTop 
)
virtual

Implements JPainter.

◆ String() [4/7]

void JPainter::String ( const JFloat  angle,
const JPoint topLeft,
const JString str,
const JCoordinate  width = 0,
const HAlign  hAlign = HAlign::kLeft,
const JCoordinate  height = 0,
const VAlign  vAlign = VAlign::kTop 
)
inline

◆ String() [5/7]

void JPainter::String ( const JFloat  angle,
const JRect rect,
const JString str,
const HAlign  hAlign = HAlign::kLeft,
const VAlign  vAlign = VAlign::kTop 
)

◆ String() [6/7]

void JPainter::String ( const JPoint topLeft,
const JString str,
const JCoordinate  width = 0,
const HAlign  hAlign = HAlign::kLeft,
const JCoordinate  height = 0,
const VAlign  vAlign = VAlign::kTop 
)
inline

◆ String() [7/7]

void JPainter::String ( const JRect rect,
const JString str,
const HAlign  hAlign = HAlign::kLeft,
const VAlign  vAlign = VAlign::kTop 
)
inline

◆ StringNoSubstitutions()

void JEPSPrinter::StringNoSubstitutions ( const JCoordinate  left,
const JCoordinate  top,
const JString str 
)
overridevirtual

Implements JPainter.

◆ WantsPreview()

bool JEPSPrinter::WantsPreview ( ) const
inline

◆ WriteEPSSetup()

void JEPSPrinter::WriteEPSSetup ( std::ostream &  output) const

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