SkDocument Class Reference

#include <SkDocument.h>

Inheritance diagram for SkDocument:

Public Member Functions
SkCanvas *	beginPage (SkScalar width, SkScalar height, const SkRect *content=nullptr)
void	endPage ()
void	close ()
void	abort ()
Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()
virtual	~SkRefCntBase ()
bool	unique () const
void	ref () const
void	unref () const

Protected Types
enum	State { kBetweenPages_State , kInPage_State , kClosed_State }

Protected Member Functions
	SkDocument (SkWStream *)
	~SkDocument () override
virtual SkCanvas *	onBeginPage (SkScalar width, SkScalar height)=0
virtual void	onEndPage ()=0
virtual void	onClose (SkWStream *)=0
virtual void	onAbort ()=0
SkWStream *	getStream ()
State	getState () const

Detailed Description

High-level API for creating a document-based canvas. To use..

1. Create a document, specifying a stream to store the output.
2. For each "page" of content: a. canvas = doc->beginPage(...) b. draw_my_content(canvas); c. doc->endPage();
3. Close the document with doc->close().

Definition at line 32 of file SkDocument.h.

Member Enumeration Documentation

State

enum SkDocument::State

protected

Enumerator
kBetweenPages_State
kInPage_State
kClosed_State

Definition at line 79 of file SkDocument.h.

               {
        kBetweenPages_State,
        kInPage_State,
        kClosed_State
    };

Constructor & Destructor Documentation

SkDocument()

SkDocument::SkDocument ( SkWStream *  stream )

protected

Definition at line 13 of file SkDocument.cpp.

: fStream(stream), fState(kBetweenPages_State) {}

~SkDocument()

SkDocument::~SkDocument ( )

overrideprotected

Definition at line 15 of file SkDocument.cpp.

                        {
    this->close();
}

Member Function Documentation

abort()

void SkDocument::abort

(

)

Call abort() to stop producing the document immediately. The stream output must be ignored, and should not be trusted.

Definition at line 72 of file SkDocument.cpp.

                       {
    this->onAbort();
 
    fState = kClosed_State;
    // we don't own the stream, but we mark it nullptr since we can
    // no longer write to it.
    fStream = nullptr;
}

beginPage()

SkCanvas * SkDocument::beginPage	(	SkScalar	width,
		SkScalar	height,
		const SkRect *	content = nullptr
	)

Begin a new page for the document, returning the canvas that will draw into the page. The document owns this canvas, and it will go out of scope when endPage() or close() is called, or the document is deleted. This will call endPage() if there is a currently active page.

Definition at line 32 of file SkDocument.cpp.

                                                       {
    if (width <= 0 || height <= 0 || kClosed_State == fState) {
        return nullptr;
    }
    if (kInPage_State == fState) {
        this->endPage();
    }
    SkASSERT(kBetweenPages_State == fState);
    fState = kInPage_State;
    return trim(this->onBeginPage(width, height), width, height, content);
}

close()

void SkDocument::close

(

)

Call close() when all pages have been drawn. This will close the file or stream holding the document's contents. After close() the document can no longer add new pages. Deleting the document will automatically call close() if need be.

Definition at line 52 of file SkDocument.cpp.

                       {
    for (;;) {
        switch (fState) {
            case kBetweenPages_State: {
                fState = kClosed_State;
                this->onClose(fStream);
                // we don't own the stream, but we mark it nullptr since we can
                // no longer write to it.
                fStream = nullptr;
                return;
            }
            case kInPage_State:
                this->endPage();
                break;
            case kClosed_State:
                return;
        }
    }
}

endPage()

void SkDocument::endPage

(

)

Call endPage() when the content for the current page has been drawn (into the canvas returned by beginPage()). After this call the canvas returned by beginPage() will be out-of-scope.

Definition at line 45 of file SkDocument.cpp.

                         {
    if (kInPage_State == fState) {
        fState = kBetweenPages_State;
        this->onEndPage();
    }
}

getState()

State SkDocument::getState ( ) const

inlineprotected

Definition at line 84 of file SkDocument.h.

{ return fState; }

getStream()

SkWStream * SkDocument::getStream ( )

inlineprotected

Definition at line 77 of file SkDocument.h.

{ return fStream; }

onAbort()

virtual void SkDocument::onAbort ( )

protectedpure virtual

Implemented in SkPDFDocument.

onBeginPage()

virtual SkCanvas * SkDocument::onBeginPage ( SkScalar  width, SkScalar  height  )

protectedpure virtual

Implemented in SkPDFDocument.

onClose()

virtual void SkDocument::onClose ( SkWStream *  )

protectedpure virtual

Implemented in SkPDFDocument.

onEndPage()

virtual void SkDocument::onEndPage ( )

protectedpure virtual

Implemented in SkPDFDocument.

---

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

• third_party/skia/include/core/SkDocument.h
• third_party/skia/src/core/SkDocument.cpp