b58772f866
Landing patchset 7 from https://codereview.appspot.com/7374052 for dml@google.com Review URL: https://codereview.chromium.org/12533009 git-svn-id: http://skia.googlecode.com/svn/trunk@8034 2bbb7eff-a529-9590-31e7-b0007b416f81
129 lines
3.2 KiB
C++
129 lines
3.2 KiB
C++
/*
|
|
* Copyright 2012 Google Inc.
|
|
*
|
|
* Use of this source code is governed by a BSD-style license that can be
|
|
* found in the LICENSE file.
|
|
*/
|
|
|
|
#ifndef SkAnnotation_DEFINED
|
|
#define SkAnnotation_DEFINED
|
|
|
|
#include "SkFlattenable.h"
|
|
|
|
class SkData;
|
|
class SkDataSet;
|
|
class SkStream;
|
|
class SkWStream;
|
|
struct SkPoint;
|
|
|
|
/**
|
|
* Experimental class for annotating draws. Do not use directly yet.
|
|
* Use helper functions at the bottom of this file for now.
|
|
*/
|
|
class SkAnnotation : public SkFlattenable {
|
|
public:
|
|
enum Flags {
|
|
// If set, the associated drawing primitive should not be drawn
|
|
kNoDraw_Flag = 1 << 0,
|
|
};
|
|
|
|
SkAnnotation(SkDataSet*, uint32_t flags);
|
|
virtual ~SkAnnotation();
|
|
|
|
uint32_t getFlags() const { return fFlags; }
|
|
SkDataSet* getDataSet() const { return fDataSet; }
|
|
|
|
bool isNoDraw() const { return SkToBool(fFlags & kNoDraw_Flag); }
|
|
|
|
/**
|
|
* Helper for search the annotation's dataset.
|
|
*/
|
|
SkData* find(const char name[]) const;
|
|
|
|
SK_DECLARE_PUBLIC_FLATTENABLE_DESERIALIZATION_PROCS(SkAnnotation)
|
|
|
|
protected:
|
|
SkAnnotation(SkFlattenableReadBuffer&);
|
|
virtual void flatten(SkFlattenableWriteBuffer&) const SK_OVERRIDE;
|
|
|
|
private:
|
|
SkDataSet* fDataSet;
|
|
uint32_t fFlags;
|
|
|
|
void writeToStream(SkWStream*) const;
|
|
void readFromStream(SkStream*);
|
|
|
|
typedef SkFlattenable INHERITED;
|
|
};
|
|
|
|
/**
|
|
* Experimental collection of predefined Keys into the Annotation dictionary
|
|
*/
|
|
class SkAnnotationKeys {
|
|
public:
|
|
/**
|
|
* Returns the canonical key whose payload is a URL
|
|
*/
|
|
static const char* URL_Key();
|
|
|
|
/**
|
|
* Returns the canonical key whose payload is the name of a destination to
|
|
* be defined.
|
|
*/
|
|
static const char* Define_Named_Dest_Key();
|
|
|
|
/**
|
|
* Returns the canonical key whose payload is the name of a destination to
|
|
* be linked to.
|
|
*/
|
|
static const char* Link_Named_Dest_Key();
|
|
};
|
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Experimental helper functions to use Annotations
|
|
//
|
|
|
|
struct SkRect;
|
|
class SkCanvas;
|
|
|
|
/**
|
|
* Experimental!
|
|
*
|
|
* Annotate the canvas by associating the specified URL with the
|
|
* specified rectangle (in local coordinates, just like drawRect). If the
|
|
* backend of this canvas does not support annotations, this call is
|
|
* safely ignored.
|
|
*
|
|
* The caller is responsible for managing its ownership of the SkData.
|
|
*/
|
|
SK_API void SkAnnotateRectWithURL(SkCanvas*, const SkRect&, SkData*);
|
|
|
|
/**
|
|
* Experimental!
|
|
*
|
|
* Annotate the canvas by associating a name with the specified point.
|
|
*
|
|
* If the backend of this canvas does not support annotations, this call is
|
|
* safely ignored.
|
|
*
|
|
* The caller is responsible for managing its ownership of the SkData.
|
|
*/
|
|
SK_API void SkAnnotateNamedDestination(SkCanvas*, const SkPoint&, SkData*);
|
|
|
|
/**
|
|
* Experimental!
|
|
*
|
|
* Annotate the canvas by making the specified rectangle link to a named
|
|
* destination.
|
|
*
|
|
* If the backend of this canvas does not support annotations, this call is
|
|
* safely ignored.
|
|
*
|
|
* The caller is responsible for managing its ownership of the SkData.
|
|
*/
|
|
SK_API void SkAnnotateLinkToDestination(SkCanvas*, const SkRect&, SkData*);
|
|
|
|
|
|
#endif
|