Struct rsvg::document::Document

pub struct Document {
    tree: Node<NodeData>,
    session: Session,
    ids: HashMap<String, Node<NodeData>>,
    resources: RefCell<Resources>,
    load_options: Arc<LoadOptions>,
    stylesheets: Vec<Stylesheet>,
}

A loaded SVG file and its derived data.

Fields

tree: Node<NodeData>

Tree of nodes; the root is guaranteed to be an <svg> element.

session: Session

Metadata about the SVG handle.

ids: HashMap<String, Node<NodeData>>

Mapping from id attributes to nodes.

resources: RefCell<Resources>

Othewr SVG documents and images referenced from this document.

This requires requires interior mutability because we load resources all over the place. Eventually we’ll be able to do this once, at loading time, and keep this immutable.

load_options: Arc<LoadOptions>

Used to load referenced resources.

stylesheets: Vec<Stylesheet>

Stylesheets defined in the document.

Implementations

impl Document

pub fn load_from_stream( session: Session, load_options: Arc<LoadOptions>, stream: &InputStream, cancellable: Option<&Cancellable> ) -> Result<Document, LoadingError>

Constructs a Document by loading it from a stream.

pub fn root(&self) -> Node<NodeData>

Gets the root node. This is guaranteed to be an <svg> element.

fn lookup_node(&self, node_id: &NodeId) -> Option<Node<NodeData>>

Looks up a node in this document or one of its resources by its id attribute.

pub fn lookup_internal_node(&self, id: &str) -> Option<Node<NodeData>>

Looks up a node in this document by its id attribute.

fn lookup_image(&self, url: &str) -> Result<SharedImageSurface, LoadingError>

Loads an image by URL, or returns a pre-loaded one.

fn lookup_resource(&self, url: &str) -> Result<Resource, LoadingError>

Loads a resource by URL, or returns a pre-loaded one.

pub fn cascade(&mut self, extra: &[Stylesheet], session: &Session)

Runs the CSS cascade on the document tree

This uses the default UserAgent stylesheet, the document’s internal stylesheets, plus an extra set of stylesheets supplied by the caller.

pub fn get_intrinsic_dimensions(&self) -> IntrinsicDimensions

pub fn render_document( &self, session: &Session, cr: &Context, viewport: &Rectangle, user_language: &UserLanguage, dpi: Dpi, svg_nesting: SvgNesting, is_testing: bool ) -> Result<(), InternalRenderingError>

pub fn render_layer( &self, session: &Session, cr: &Context, node: Node<NodeData>, viewport: &Rectangle, user_language: &UserLanguage, dpi: Dpi, svg_nesting: SvgNesting, is_testing: bool ) -> Result<(), InternalRenderingError>

fn geometry_for_layer( &self, session: &Session, node: Node<NodeData>, viewport: Rect, user_language: &UserLanguage, dpi: Dpi, is_testing: bool ) -> Result<(Rect, Rect), InternalRenderingError>

pub fn get_geometry_for_layer( &self, session: &Session, node: Node<NodeData>, viewport: &Rectangle, user_language: &UserLanguage, dpi: Dpi, is_testing: bool ) -> Result<(Rectangle, Rectangle), InternalRenderingError>

fn get_bbox_for_element( &self, session: &Session, node: &Node<NodeData>, user_language: &UserLanguage, dpi: Dpi, is_testing: bool ) -> Result<BoundingBox, InternalRenderingError>

pub fn get_geometry_for_element( &self, session: &Session, node: Node<NodeData>, user_language: &UserLanguage, dpi: Dpi, is_testing: bool ) -> Result<(Rectangle, Rectangle), InternalRenderingError>

Returns (ink_rect, logical_rect)

pub fn render_element( &self, session: &Session, cr: &Context, node: Node<NodeData>, element_viewport: &Rectangle, user_language: &UserLanguage, dpi: Dpi, is_testing: bool ) -> Result<(), InternalRenderingError>