zathura
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
Data Structures | Enumerations | Functions
types.h File Reference
#include <girara/datastructures.h>
#include "macros.h"

Go to the source code of this file.

Data Structures

struct  zathura_image_buffer_t
struct  zathura_rectangle_t
struct  zathura_image_t
struct  zathura_link_target_t
struct  zathura_index_element_t
struct  zathura_form_t

Enumerations

enum  zathura_error_t {
  ZATHURA_ERROR_OK, ZATHURA_ERROR_UNKNOWN, ZATHURA_ERROR_OUT_OF_MEMORY, ZATHURA_ERROR_NOT_IMPLEMENTED,
  ZATHURA_ERROR_INVALID_ARGUMENTS, ZATHURA_ERROR_INVALID_PASSWORD
}
enum  zathura_document_information_type_t {
  ZATHURA_DOCUMENT_INFORMATION_TITLE, ZATHURA_DOCUMENT_INFORMATION_AUTHOR, ZATHURA_DOCUMENT_INFORMATION_SUBJECT, ZATHURA_DOCUMENT_INFORMATION_KEYWORDS,
  ZATHURA_DOCUMENT_INFORMATION_CREATOR, ZATHURA_DOCUMENT_INFORMATION_PRODUCER, ZATHURA_DOCUMENT_INFORMATION_CREATION_DATE, ZATHURA_DOCUMENT_INFORMATION_MODIFICATION_DATE,
  ZATHURA_DOCUMENT_INFORMATION_OTHER
}
enum  zathura_adjust_mode_t { ZATHURA_ADJUST_NONE, ZATHURA_ADJUST_BESTFIT, ZATHURA_ADJUST_WIDTH, ZATHURA_ADJUST_INPUTBAR }
enum  zathura_link_type_t {
  ZATHURA_LINK_INVALID, ZATHURA_LINK_NONE, ZATHURA_LINK_GOTO_DEST, ZATHURA_LINK_GOTO_REMOTE,
  ZATHURA_LINK_URI, ZATHURA_LINK_LAUNCH, ZATHURA_LINK_NAMED
}
enum  zathura_link_destination_type_t {
  ZATHURA_LINK_DESTINATION_UNKNOWN, ZATHURA_LINK_DESTINATION_XYZ, ZATHURA_LINK_DESTINATION_FIT, ZATHURA_LINK_DESTINATION_FITH,
  ZATHURA_LINK_DESTINATION_FITV, ZATHURA_LINK_DESTINATION_FITR, ZATHURA_LINK_DESTINATION_FITB, ZATHURA_LINK_DESTINATION_FITBH,
  ZATHURA_LINK_DESTINATION_FITBV
}
enum  zathura_form_type_t { ZATHURA_FORM_CHECKBOX, ZATHURA_FORM_TEXTFIELD }

Functions

zathura_image_buffer_tzathura_image_buffer_create (unsigned int width, unsigned int height)
void zathura_image_buffer_free (zathura_image_buffer_t *buffer)
zathura_index_element_tzathura_index_element_new (const char *title)
void zathura_index_element_free (zathura_index_element_t *index)
girara_list_t * zathura_document_information_entry_list_new ()
zathura_document_information_entry_t * zathura_document_information_entry_new (zathura_document_information_type_t type, const char *value)
void zathura_document_information_entry_free (zathura_document_information_entry_t *entry)

Enumeration Type Documentation

Adjust mode

Enumerator:
ZATHURA_ADJUST_NONE 

No adjustment

ZATHURA_ADJUST_BESTFIT 

Adjust to best-fit

ZATHURA_ADJUST_WIDTH 

Adjust to width

ZATHURA_ADJUST_INPUTBAR 

Focusing the inputbar

Definition at line 99 of file types.h.

Possible information entry types

Enumerator:
ZATHURA_DOCUMENT_INFORMATION_TITLE 

Title of the document

ZATHURA_DOCUMENT_INFORMATION_AUTHOR 

Author of the document

ZATHURA_DOCUMENT_INFORMATION_SUBJECT 

Subject of the document

ZATHURA_DOCUMENT_INFORMATION_KEYWORDS 

Keywords of the document

ZATHURA_DOCUMENT_INFORMATION_CREATOR 

Creator of the document

ZATHURA_DOCUMENT_INFORMATION_PRODUCER 

Producer of the document

ZATHURA_DOCUMENT_INFORMATION_CREATION_DATE 

Creation data

ZATHURA_DOCUMENT_INFORMATION_MODIFICATION_DATE 

Modification data

ZATHURA_DOCUMENT_INFORMATION_OTHER 

Any other information

Definition at line 59 of file types.h.

Error types

Enumerator:
ZATHURA_ERROR_OK 

No error occured

ZATHURA_ERROR_UNKNOWN 

An unknown error occured

ZATHURA_ERROR_OUT_OF_MEMORY 

Out of memory

ZATHURA_ERROR_NOT_IMPLEMENTED 

The called function has not been implemented

ZATHURA_ERROR_INVALID_ARGUMENTS 

Invalid arguments have been passed

ZATHURA_ERROR_INVALID_PASSWORD 

The provided password is invalid

Definition at line 46 of file types.h.

Form type

Enumerator:
ZATHURA_FORM_CHECKBOX 

Checkbox

ZATHURA_FORM_TEXTFIELD 

Textfield

Definition at line 201 of file types.h.

Enumerator:
ZATHURA_LINK_DESTINATION_UNKNOWN 
ZATHURA_LINK_DESTINATION_XYZ 
ZATHURA_LINK_DESTINATION_FIT 
ZATHURA_LINK_DESTINATION_FITH 
ZATHURA_LINK_DESTINATION_FITV 
ZATHURA_LINK_DESTINATION_FITR 
ZATHURA_LINK_DESTINATION_FITB 
ZATHURA_LINK_DESTINATION_FITBH 
ZATHURA_LINK_DESTINATION_FITBV 

Definition at line 159 of file types.h.

Possible link types

Enumerator:
ZATHURA_LINK_INVALID 

Invalid type

ZATHURA_LINK_NONE 

No action

ZATHURA_LINK_GOTO_DEST 

Links to a page

ZATHURA_LINK_GOTO_REMOTE 

Links to a page

ZATHURA_LINK_URI 

Links to an external source

ZATHURA_LINK_LAUNCH 

Links to an external source

ZATHURA_LINK_NAMED 

Links to an external source

Definition at line 148 of file types.h.

Function Documentation

void zathura_document_information_entry_free ( zathura_document_information_entry_t *  entry)

Frees a document information entry

Parameters
entryThe entry that should be freed

Definition at line 104 of file types.c.

girara_list_t* zathura_document_information_entry_list_new ( )

Creates a list that should be used to store zathura_document_information_entry_t entries

Returns
A list or NULL if an error occured

Definition at line 75 of file types.c.

zathura_document_information_entry_t* zathura_document_information_entry_new ( zathura_document_information_type_t  type,
const char *  value 
)

Creates a new document information entry

Parameters
typeThe type
valueThe value
Returns
A new entry or NULL if an error occured

Definition at line 84 of file types.c.

zathura_image_buffer_t* zathura_image_buffer_create ( unsigned int  width,
unsigned int  height 
)

Creates an image buffer

Parameters
widthWidth of the image stored in the buffer
heightHeight of the image stored in the buffer
Returns
Image buffer or NULL if an error occured

Definition at line 41 of file types.c.

void zathura_image_buffer_free ( zathura_image_buffer_t buffer)

Frees the image buffer

Parameters
bufferThe image buffer

Definition at line 64 of file types.c.

void zathura_index_element_free ( zathura_index_element_t index)

Free index element

Parameters
indexThe index element

Definition at line 29 of file types.c.

zathura_index_element_t* zathura_index_element_new ( const char *  title)

Create new index element

Parameters
titleTitle of the index element
Returns
Index element

Definition at line 12 of file types.c.