document Struct Reference

#include <document.h>

Collaboration diagram for document:

Public Member Functions
	LIST_HEAD_EL (struct document)

Data Fields
struct elinks_object	object
struct document_options	options
struct form list	forms
struct tag list	tags
struct node list	nodes
struct iframe2 list	iframes
struct ecmascript_string_list_item list	onload_snippets
	ECMAScript snippets to be executed during loading the document into a window.
struct uri_list	ecmascript_imports
int	ecmascript_counter
char *	body_onkeypress
struct offset_linknum *	offset_linknum
struct iframeset_desc *	iframeset_desc
struct uri *	uri
void *	querydns
char *	ip
char *	title
	The title of the document.
struct cache_entry *	cached
struct frame_desc *	frame
struct frameset_desc *	frame_desc
struct document_refresh *	refresh
struct line *	data
struct link *	links
struct reverse_link_lookup *	reverse_link_lookup
struct search *	search
struct search **	slines1
struct search **	slines2
struct point *	search_points
char	buf [7]
unsigned char	buf_length
unsigned int	cache_id
	Used to check cache entries.
int	cp
int	width
int	height
	size of document
int	nlinks
int	nsearch
int	number_of_search_points
struct {
color_T   background
}	color
enum cp_status	cp_status
unsigned int	links_sorted:1
	whether links are already sorted
unsigned int	offset_sorted:1
unsigned int	scanned:1
struct el_box	clipboard_box
enum clipboard_status	clipboard_status
Arrays with one item per rendered document's line.
struct link **	lines1
	The first link on the line.
struct link **	lines2
	The last link on the line.

Related Symbols
(Note that these are not member symbols.)
struct document *	init_document (struct cache_entry *cached, struct document_options *options)
	Initializes a document and its canvas.
void	done_document (struct document *document)
	Releases the document and all its resources.
void	release_document (struct document *document)
	Release a reference to the document.

Member Function Documentation

LIST_HEAD_EL()

document::LIST_HEAD_EL

(

struct document

)

Friends And Related Symbol Documentation

done_document()

void done_document ( struct document * document )

related

Releases the document and all its resources.

init_document()

struct document * init_document ( struct cache_entry * cached, struct document_options * options )

related

Initializes a document and its canvas.

Returns

NULL on allocation failure.

release_document()

void release_document ( struct document * document )

related

Release a reference to the document.

Field Documentation

background

color_T document::background

body_onkeypress

char* document::body_onkeypress

buf

char document::buf[7]

buf_length

unsigned char document::buf_length

cache_id

unsigned int document::cache_id

Used to check cache entries.

cached

struct cache_entry* document::cached

clipboard_box

struct el_box document::clipboard_box

clipboard_status

enum clipboard_status document::clipboard_status

[struct]

struct { ... } document::color

cp

int document::cp

cp_status

enum cp_status document::cp_status

data

struct line* document::data

ecmascript_counter

int document::ecmascript_counter

ecmascript_imports

struct uri_list document::ecmascript_imports

Todo

FIXME: We should externally maybe using cache_entry store the dependencies between the various entries so nothing gets removed unneeded.

forms

struct form list document::forms

frame

struct frame_desc* document::frame

frame_desc

struct frameset_desc* document::frame_desc

Todo

RENAME ME

height

int document::height

size of document

iframes

struct iframe2 list document::iframes

iframeset_desc

struct iframeset_desc* document::iframeset_desc

ip

char* document::ip

lines1

struct link** document::lines1

The first link on the line.

lines2

struct link** document::lines2

The last link on the line.

links

struct link* document::links

links_sorted

unsigned int document::links_sorted

whether links are already sorted

nlinks

int document::nlinks

nodes

struct node list document::nodes

nsearch

int document::nsearch

number_of_search_points

int document::number_of_search_points

object

struct elinks_object document::object

offset_linknum

struct offset_linknum* document::offset_linknum

offset_sorted

unsigned int document::offset_sorted

onload_snippets

struct ecmascript_string_list_item list document::onload_snippets

ECMAScript snippets to be executed during loading the document into a window.

This currently involves <script>s and onLoad handlers. Note that if you hit a string beginning by '^' here, it is followed by an external reference - you must wait with processing other items until it gets resolved and loaded. New items are guaranteed to always appear at the list end.

options

struct document_options document::options

querydns

void* document::querydns

refresh

struct document_refresh* document::refresh

reverse_link_lookup

struct reverse_link_lookup* document::reverse_link_lookup

scanned

unsigned int document::scanned

search

struct search* document::search

search_points

struct point* document::search_points

slines1

struct search** document::slines1

slines2

struct search** document::slines2

tags

struct tag list document::tags

title

char* document::title

The title of the document.

The charset of this string is document.options.cp.

uri

struct uri* document::uri

width

int document::width

---

The documentation for this struct was generated from the following file:

• document/document.h