style.h revision 276649197eb83cda15c90a3b2fec92be207f3475
#ifndef SEEN_SP_STYLE_H
#define SEEN_SP_STYLE_H
/** \file
* SPStyle - a style object for SPItem objects
*/
/* Authors:
* Lauris Kaplinski <lauris@kaplinski.com>
* Jon A. Cruz <jon@joncruz.org>
* Tavmjong Bah <tavmjong@free.fr>
*
* Copyright (C) 2014 Tavmjong Bah
* Copyright (C) 2010 Jon A. Cruz
* Copyright (C) 2001-2002 Lauris Kaplinski
* Copyright (C) 2001 Ximian, Inc.
*
* Released under GNU GPL, read the file 'COPYING' for more information
*/
#include "style-enums.h"
#include "style-internal.h"
#include <sigc++/connection.h>
#include <iostream>
#include <vector>
// Define SPIBasePtr, a Pointer to a data member of SPStyle of type SPIBase;
typedef SPIBase SPStyle::*SPIBasePtr;
// Define SPPropMap, a map linking property name to property data
// typedef std::map<std::string, SPIBasePtr> SPPropMap;
namespace Inkscape {
namespace XML {
class Node;
}
}
#include "libcroco/cr-declaration.h"
#include "libcroco/cr-prop-list.h"
/// An SVG style object.
class SPStyle {
public:
SPStyle(SPDocument *document = NULL, SPObject *object = NULL);// document is ignored if valid object given
~SPStyle();
void clear();
void read(SPObject *object, Inkscape::XML::Node *repr);
void readFromObject(SPObject *object);
void readFromPrefs(Glib::ustring const &path);
void readIfUnset( int id, char const *val );
Glib::ustring write( unsigned int const flags, SPStyle const *const base = NULL ) const;
void cascade( SPStyle const *const parent );
void merge( SPStyle const *const parent );
bool operator==(const SPStyle& rhs);
int ref() { ++_refcount; return _refcount; }
int unref() { --_refcount; return _refcount; }
//FIXME: Make private
public:
void _mergeString( char const *const p ); // Rename to readFromString?
private:
void _mergeDeclList( CRDeclaration const *const decl_list );
void _mergeDecl( CRDeclaration const *const decl );
void _mergeProps( CRPropList *const props );
void _mergeObjectStylesheet( SPObject const *const object );
private:
int _refcount;
static int _count; // Poor man's leak detector
// FIXME: Make private
public:
/** Object we are attached to */
SPObject *object;
/** Document we are associated with */
SPDocument *document;
private:
/// Pointers to all the properties (for looping through them)
std::vector<SPIBase *> _properties;
// static SPPropMap _propmap;
public:
/* ----------------------- THE PROPERTIES ------------------------- */
/* Match order in style.cpp. */
/* Font ---------------------------- */
/** Font style */
SPIEnum font_style;
/** Which substyle of the font */
SPIEnum font_variant;
/** Weight of the font */
SPIEnum font_weight;
/** Stretch of the font */
SPIEnum font_stretch;
/** Size of the font */
SPIFontSize font_size;
/** Line height (css2 10.8.1) */
SPILengthOrNormal line_height;
/** Font family */
SPIString font_family;
/** Font shorthand */
SPIFont font;
/** Full font name, as font_factory::ConstructFontSpecification would give, for internal use. */
SPIString font_specification;
/* Text ----------------------------- */
/** First line indent of paragraphs (css2 16.1) */
SPILength text_indent;
/** text alignment (css2 16.2) (not to be confused with text-anchor) */
SPIEnum text_align;
/** letter spacing (css2 16.4) */
SPILengthOrNormal letter_spacing;
/** word spacing (also css2 16.4) */
SPILengthOrNormal word_spacing;
/** capitalization (css2 16.5) */
SPIEnum text_transform;
/* CSS3 Text */
/** text direction (css3 text 3.2) */
SPIEnum direction;
/** block progression (css3 text 3.2) */
SPIEnum block_progression;
/** Writing mode (css3 text 3.2 and svg1.1 10.7.2) */
SPIEnum writing_mode;
/** Baseline shift (svg1.1 10.9.2) */
SPIBaselineShift baseline_shift;
/* SVG */
/** Anchor of the text (svg1.1 10.9.1) */
SPIEnum text_anchor;
/** white space (svg2) */
SPIEnum white_space;
/* Text Decoration ----------------------- */
/** text decoration (css2 16.3.1) */
SPITextDecoration text_decoration;
/** CSS 3 2.1, 2.2, 2.3 */
/** Not done yet, test_decoration3 = css3 2.4*/
SPITextDecorationLine text_decoration_line;
SPITextDecorationStyle text_decoration_style; // SPIEnum? Only one can be set at time.
SPIColor text_decoration_color;
// used to implement text_decoration, not saved to or read from SVG file
SPITextDecorationData text_decoration_data;
// 16.3.2 is text-shadow. That's complicated.
/* General visual properties ------------- */
/** clip-rule: 0 nonzero, 1 evenodd */
SPIEnum clip_rule;
/** display */
SPIEnum display;
/** overflow */
SPIEnum overflow;
/** visibility */
SPIEnum visibility;
/** opacity */
SPIScale24 opacity;
/** mix-blend-mode: CSS Compositing and Blending Level 1 */
SPIEnum isolation;
SPIEnum mix_blend_mode;
SPIPaintOrder paint_order;
/** color */
SPIColor color;
/** color-interpolation */
SPIEnum color_interpolation;
/** color-interpolation-filters */
SPIEnum color_interpolation_filters;
/** solid-color */
SPIColor solid_color;
/** solid-opacity */
SPIScale24 solid_opacity;
/** fill */
SPIPaint fill;
/** fill-opacity */
SPIScale24 fill_opacity;
/** fill-rule: 0 nonzero, 1 evenodd */
SPIEnum fill_rule;
/** stroke */
SPIPaint stroke;
/** stroke-width */
SPILength stroke_width;
/** stroke-linecap */
SPIEnum stroke_linecap;
/** stroke-linejoin */
SPIEnum stroke_linejoin;
/** stroke-miterlimit */
SPIFloat stroke_miterlimit;
/** stroke-dasharray */
SPIDashArray stroke_dasharray;
/** stroke-dashoffset */
SPILength stroke_dashoffset;
/** stroke-opacity */
SPIScale24 stroke_opacity;
/** Marker list */
SPIString marker;
SPIString marker_start;
SPIString marker_mid;
SPIString marker_end;
SPIString* marker_ptrs[SP_MARKER_LOC_QTY];
/* Filter effects ------------------------ */
/** Filter effect */
SPIFilter filter;
/** Filter blend mode */
SPIEnum filter_blend_mode;
/** normally not used, but duplicates the Gaussian blur deviation (if any) from the attached
filter when the style is used for querying */
SPILength filter_gaussianBlur_deviation;
/** enable-background, used for defining where filter effects get their background image */
SPIEnum enable_background;
/* Rendering hints ----------------------- */
/** hints on how to render: e.g. speed vs. accuracy.
* As of April, 2013, only image_rendering used. */
SPIEnum color_rendering;
SPIEnum image_rendering;
SPIEnum shape_rendering;
SPIEnum text_rendering;
/* ----------------------- END PROPERTIES ------------------------- */
/// style belongs to a cloned object
bool cloned;
sigc::connection release_connection;
sigc::connection filter_modified_connection;
sigc::connection fill_ps_modified_connection;
sigc::connection stroke_ps_modified_connection;
sigc::connection fill_ps_changed_connection;
sigc::connection stroke_ps_changed_connection;
/**
* Emitted when paint server object, fill paint refers to, is changed. That is
* when the reference starts pointing to a different address in memory.
*
* NB It is different from fill_ps_modified signal. When paint server is modified
* it means some of it's attributes or chilren change.
*/
sigc::signal<void, SPObject *, SPObject *> signal_fill_ps_changed;
/**
* Emitted when paint server object, fill paint refers to, is changed. That is
* when the reference starts pointing to a different address in memory.
*/
sigc::signal<void, SPObject *, SPObject *> signal_stroke_ps_changed;
SPObject *getFilter() { return (filter.href) ? filter.href->getObject() : NULL; }
SPObject const *getFilter() const { return (filter.href) ? filter.href->getObject() : NULL; }
char const *getFilterURI() const { return (filter.href) ? filter.href->getURI()->toString() : NULL; }
SPPaintServer *getFillPaintServer() { return (fill.value.href) ? fill.value.href->getObject() : NULL; }
SPPaintServer const *getFillPaintServer() const { return (fill.value.href) ? fill.value.href->getObject() : NULL; }
char const *getFillURI() const { return (fill.value.href) ? fill.value.href->getURI()->toString() : NULL; }
SPPaintServer *getStrokePaintServer() { return (stroke.value.href) ? stroke.value.href->getObject() : NULL; }
SPPaintServer const *getStrokePaintServer() const { return (stroke.value.href) ? stroke.value.href->getObject() : NULL; }
char const *getStrokeURI() const { return (stroke.value.href) ? stroke.value.href->getURI()->toString() : NULL; }
};
SPStyle *sp_style_new(SPDocument *document); // SPStyle::SPStyle( SPDocument *document = NULL );
SPStyle *sp_style_new_from_object(SPObject *object); // SPStyle::SPStyle( SPObject *object );
SPStyle *sp_style_ref(SPStyle *style); // SPStyle::ref();
SPStyle *sp_style_unref(SPStyle *style); // SPStyle::unref();
void sp_style_read_from_object(SPStyle *style, SPObject *object); //SPStyle::read( SPObject * object);
void sp_style_read_from_prefs(SPStyle *style, Glib::ustring const &path); // SPStyle::read( ... );
void sp_style_merge_from_style_string(SPStyle *style, char const *p); // SPStyle::merge( ... );?
void sp_style_merge_from_parent(SPStyle *style, SPStyle const *parent); // SPStyle::cascade( ... );
void sp_style_merge_from_dying_parent(SPStyle *style, SPStyle const *parent); // SPStyle::merge( ... )
char *sp_style_write_string(SPStyle const *style, unsigned int flags = SP_STYLE_FLAG_IFSET);//SPStyle::write
char *sp_style_write_difference(SPStyle const *from, SPStyle const *to); // SPStyle::write
void sp_style_set_to_uri_string (SPStyle *style, bool isfill, const char *uri); // ?
char const *sp_style_get_css_unit_string(int unit); // No change?
double sp_style_css_size_px_to_units(double size, int unit); // No change?
double sp_style_css_size_units_to_px(double size, int unit); // No change?
SPCSSAttr *sp_css_attr_from_style (SPStyle const *const style, unsigned int flags);
SPCSSAttr *sp_css_attr_from_object(SPObject *object, unsigned int flags = SP_STYLE_FLAG_IFSET);
SPCSSAttr *sp_css_attr_unset_text(SPCSSAttr *css);
SPCSSAttr *sp_css_attr_unset_blacklist(SPCSSAttr *css);
SPCSSAttr *sp_css_attr_unset_uris(SPCSSAttr *css);
SPCSSAttr *sp_css_attr_scale(SPCSSAttr *css, double ex);
void sp_style_unset_property_attrs(SPObject *o);
void sp_style_set_property_url (SPObject *item, char const *property, SPObject *linked, bool recursive);
void css_quote( Glib::ustring &val ); // Add quotes around CSS values
void css_unquote( Glib::ustring &val ); // Remove quotes from CSS values (style-internal.cpp, xml/repr-css.cpp)
void css_font_family_quote( Glib::ustring &val ); // style-internal.cpp, text-toolbar.cpp
void css_font_family_unquote( Glib::ustring &val ); // style-internal.cpp, text-toolbar.cpp
Glib::ustring css2_escape_quote(char const *val);
#endif // SEEN_SP_STYLE_H
/*
Local Variables:
mode:c++
c-file-style:"stroustrup"
c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
indent-tabs-mode:nil
fill-column:99
End:
*/
// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :