ELinks 0.16.1.1
document Struct Reference

#include <document.h>

Collaboration diagram for document:

Data Fields

void * magic1
struct documentnext
struct documentprev
void * magic2
struct object object
struct document_options options
struct form list forms
struct tag list tags
struct node list nodes
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
struct ecmascript_timeout list timeouts
 used by setTimeout
int ecmascript_counter
void * dom
void * element_map
char * text
void * forms_nodeset
struct iframeset_desciframe_desc
struct uriuri
void * querydns
char * ip
char * title
 The title of the document.
struct cache_entrycached
struct frame_descframe
struct frameset_descframe_desc
struct document_refreshrefresh
struct linedata
struct linklinks
struct searchsearch
struct search ** slines1
struct search ** slines2
struct pointsearch_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
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.

(Note that these are not member symbols.)

struct documentinit_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.

◆ 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

◆ 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

◆ dom

void* document::dom

◆ 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.

◆ element_map

void* document::element_map

◆ forms

struct form list document::forms

◆ forms_nodeset

void* document::forms_nodeset

◆ frame

struct frame_desc* document::frame

◆ frame_desc

struct frameset_desc* document::frame_desc
Todo
RENAME ME

◆ height

int document::height

size of document

◆ iframe_desc

struct iframeset_desc* document::iframe_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

◆ magic1

void* document::magic1

◆ magic2

void* document::magic2

◆ next

struct document* document::next

◆ 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 object document::object

◆ 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

◆ prev

struct document* document::prev

◆ querydns

void* document::querydns

◆ refresh

struct document_refresh* document::refresh

◆ 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

◆ text

char* document::text

◆ timeouts

struct ecmascript_timeout list document::timeouts

used by setTimeout

◆ 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: