Evince
Evince is a document viewer capable of displaying multiple and single page document formats like PDF and Postscript.
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Data Structures | Macros | Typedefs | Enumerations | Functions
ev-document-info.h File Reference
#include <glib-object.h>
#include <glib.h>
+ Include dependency graph for ev-document-info.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _EvDocumentInfo
 
struct  _EvDocumentLicense
 

Macros

#define EV_TYPE_DOCUMENT_INFO   (ev_document_info_get_type())
 
#define _PERMISSIONS_FULL
 
#define EV_TYPE_DOCUMENT_LICENSE   (ev_document_license_get_type())
 

Typedefs

typedef typedefG_BEGIN_DECLS
struct _EvDocumentInfo 		EvDocumentInfo
 
typedef struct _EvDocumentLicense EvDocumentLicense
 

Enumerations

enum  EvDocumentLayout {
  EV_DOCUMENT_LAYOUT_SINGLE_PAGE, EV_DOCUMENT_LAYOUT_ONE_COLUMN, EV_DOCUMENT_LAYOUT_TWO_COLUMN_LEFT, EV_DOCUMENT_LAYOUT_TWO_COLUMN_RIGHT,
  EV_DOCUMENT_LAYOUT_TWO_PAGE_LEFT, EV_DOCUMENT_LAYOUT_TWO_PAGE_RIGHT
}
 
enum  EvDocumentMode {
  EV_DOCUMENT_MODE_NONE, EV_DOCUMENT_MODE_USE_OC, EV_DOCUMENT_MODE_USE_THUMBS, EV_DOCUMENT_MODE_FULL_SCREEN,
  EV_DOCUMENT_MODE_USE_ATTACHMENTS, EV_DOCUMENT_MODE_PRESENTATION = EV_DOCUMENT_MODE_FULL_SCREEN
}
 
enum  EvDocumentUIHints {
  EV_DOCUMENT_UI_HINT_HIDE_TOOLBAR = 1 << 0, EV_DOCUMENT_UI_HINT_HIDE_MENUBAR = 1 << 1, EV_DOCUMENT_UI_HINT_HIDE_WINDOWUI = 1 << 2, EV_DOCUMENT_UI_HINT_FIT_WINDOW = 1 << 3,
  EV_DOCUMENT_UI_HINT_CENTER_WINDOW = 1 << 4, EV_DOCUMENT_UI_HINT_DISPLAY_DOC_TITLE = 1 << 5, EV_DOCUMENT_UI_HINT_DIRECTION_RTL = 1 << 6
}
 
enum  EvDocumentPermissions {
  EV_DOCUMENT_PERMISSIONS_OK_TO_PRINT = 1 << 0, EV_DOCUMENT_PERMISSIONS_OK_TO_MODIFY = 1 << 1, EV_DOCUMENT_PERMISSIONS_OK_TO_COPY = 1 << 2, EV_DOCUMENT_PERMISSIONS_OK_TO_ADD_NOTES = 1 << 3,
  EV_DOCUMENT_PERMISSIONS_FULL = _PERMISSIONS_FULL
}
 
enum  EvDocumentInfoFields {
  EV_DOCUMENT_INFO_TITLE = 1 << 0, EV_DOCUMENT_INFO_FORMAT = 1 << 1, EV_DOCUMENT_INFO_AUTHOR = 1 << 2, EV_DOCUMENT_INFO_SUBJECT = 1 << 3,
  EV_DOCUMENT_INFO_KEYWORDS = 1 << 4, EV_DOCUMENT_INFO_LAYOUT = 1 << 5, EV_DOCUMENT_INFO_CREATOR = 1 << 6, EV_DOCUMENT_INFO_PRODUCER = 1 << 7,
  EV_DOCUMENT_INFO_CREATION_DATE = 1 << 8, EV_DOCUMENT_INFO_MOD_DATE = 1 << 9, EV_DOCUMENT_INFO_LINEARIZED = 1 << 10, EV_DOCUMENT_INFO_START_MODE = 1 << 11,
  EV_DOCUMENT_INFO_UI_HINTS = 1 << 12, EV_DOCUMENT_INFO_PERMISSIONS = 1 << 13, EV_DOCUMENT_INFO_N_PAGES = 1 << 14, EV_DOCUMENT_INFO_SECURITY = 1 << 15,
  EV_DOCUMENT_INFO_PAPER_SIZE = 1 << 16, EV_DOCUMENT_INFO_LICENSE = 1 << 17
}
 

Functions

GType ev_document_info_get_type (void) G_GNUC_CONST
 
EvDocumentInfo * ev_document_info_copy (EvDocumentInfo *info)
 
void ev_document_info_free (EvDocumentInfo *info)
 
GType ev_document_license_get_type (void) G_GNUC_CONST
 
EvDocumentLicense * ev_document_license_new (void)
 
EvDocumentLicense * ev_document_license_copy (EvDocumentLicense *license)
 
void ev_document_license_free (EvDocumentLicense *license)
 
const gchar * ev_document_license_get_text (EvDocumentLicense *license)
 
const gchar * ev_document_license_get_uri (EvDocumentLicense *license)
 
const gchar * ev_document_license_get_web_statement (EvDocumentLicense *license)
 

Macro Definition Documentation

#define _PERMISSIONS_FULL
Value:
(EV_DOCUMENT_PERMISSIONS_OK_TO_PRINT \
| EV_DOCUMENT_PERMISSIONS_OK_TO_MODIFY \
| EV_DOCUMENT_PERMISSIONS_OK_TO_COPY \
| EV_DOCUMENT_PERMISSIONS_OK_TO_ADD_NOTES)

Definition at line 70 of file ev-document-info.h.

#define EV_TYPE_DOCUMENT_INFO   (ev_document_info_get_type())

Definition at line 36 of file ev-document-info.h.

#define EV_TYPE_DOCUMENT_LICENSE   (ev_document_license_get_type())

Definition at line 138 of file ev-document-info.h.

Typedef Documentation

typedef typedefG_BEGIN_DECLS struct _EvDocumentInfo EvDocumentInfo

Definition at line 33 of file ev-document-info.h.

typedef struct _EvDocumentLicense EvDocumentLicense

Definition at line 34 of file ev-document-info.h.

Enumeration Type Documentation

enum EvDocumentInfoFields
Enumerator
EV_DOCUMENT_INFO_TITLE 
EV_DOCUMENT_INFO_FORMAT 
EV_DOCUMENT_INFO_AUTHOR 
EV_DOCUMENT_INFO_SUBJECT 
EV_DOCUMENT_INFO_KEYWORDS 
EV_DOCUMENT_INFO_LAYOUT 
EV_DOCUMENT_INFO_CREATOR 
EV_DOCUMENT_INFO_PRODUCER 
EV_DOCUMENT_INFO_CREATION_DATE 
EV_DOCUMENT_INFO_MOD_DATE 
EV_DOCUMENT_INFO_LINEARIZED 
EV_DOCUMENT_INFO_START_MODE 
EV_DOCUMENT_INFO_UI_HINTS 
EV_DOCUMENT_INFO_PERMISSIONS 
EV_DOCUMENT_INFO_N_PAGES 
EV_DOCUMENT_INFO_SECURITY 
EV_DOCUMENT_INFO_PAPER_SIZE 
EV_DOCUMENT_INFO_LICENSE 

Definition at line 84 of file ev-document-info.h.

85 {
86  EV_DOCUMENT_INFO_TITLE = 1 << 0,
87  EV_DOCUMENT_INFO_FORMAT = 1 << 1,
88  EV_DOCUMENT_INFO_AUTHOR = 1 << 2,
89  EV_DOCUMENT_INFO_SUBJECT = 1 << 3,
90  EV_DOCUMENT_INFO_KEYWORDS = 1 << 4,
91  EV_DOCUMENT_INFO_LAYOUT = 1 << 5,
92  EV_DOCUMENT_INFO_CREATOR = 1 << 6,
93  EV_DOCUMENT_INFO_PRODUCER = 1 << 7,
94  EV_DOCUMENT_INFO_CREATION_DATE = 1 << 8,
95  EV_DOCUMENT_INFO_MOD_DATE = 1 << 9,
96  EV_DOCUMENT_INFO_LINEARIZED = 1 << 10,
97  EV_DOCUMENT_INFO_START_MODE = 1 << 11,
98  EV_DOCUMENT_INFO_UI_HINTS = 1 << 12,
99  EV_DOCUMENT_INFO_PERMISSIONS = 1 << 13,
100  EV_DOCUMENT_INFO_N_PAGES = 1 << 14,
101  EV_DOCUMENT_INFO_SECURITY = 1 << 15,
102  EV_DOCUMENT_INFO_PAPER_SIZE = 1 << 16,
103  EV_DOCUMENT_INFO_LICENSE = 1 << 17
104 
105 } EvDocumentInfoFields;
enum EvDocumentLayout
Enumerator
EV_DOCUMENT_LAYOUT_SINGLE_PAGE 
EV_DOCUMENT_LAYOUT_ONE_COLUMN 
EV_DOCUMENT_LAYOUT_TWO_COLUMN_LEFT 
EV_DOCUMENT_LAYOUT_TWO_COLUMN_RIGHT 
EV_DOCUMENT_LAYOUT_TWO_PAGE_LEFT 
EV_DOCUMENT_LAYOUT_TWO_PAGE_RIGHT 

Definition at line 38 of file ev-document-info.h.

39 {
40  EV_DOCUMENT_LAYOUT_SINGLE_PAGE,
41  EV_DOCUMENT_LAYOUT_ONE_COLUMN,
42  EV_DOCUMENT_LAYOUT_TWO_COLUMN_LEFT,
43  EV_DOCUMENT_LAYOUT_TWO_COLUMN_RIGHT,
44  EV_DOCUMENT_LAYOUT_TWO_PAGE_LEFT,
45  EV_DOCUMENT_LAYOUT_TWO_PAGE_RIGHT
46 } EvDocumentLayout;
enum EvDocumentMode
Enumerator
EV_DOCUMENT_MODE_NONE 
EV_DOCUMENT_MODE_USE_OC 
EV_DOCUMENT_MODE_USE_THUMBS 
EV_DOCUMENT_MODE_FULL_SCREEN 
EV_DOCUMENT_MODE_USE_ATTACHMENTS 
EV_DOCUMENT_MODE_PRESENTATION 

Definition at line 48 of file ev-document-info.h.

49 {
50  EV_DOCUMENT_MODE_NONE,
51  EV_DOCUMENT_MODE_USE_OC,
52  EV_DOCUMENT_MODE_USE_THUMBS,
53  EV_DOCUMENT_MODE_FULL_SCREEN,
54  EV_DOCUMENT_MODE_USE_ATTACHMENTS,
55  EV_DOCUMENT_MODE_PRESENTATION = EV_DOCUMENT_MODE_FULL_SCREEN /* Will these be different? */
56 } EvDocumentMode;
enum EvDocumentPermissions
Enumerator
EV_DOCUMENT_PERMISSIONS_OK_TO_PRINT 
EV_DOCUMENT_PERMISSIONS_OK_TO_MODIFY 
EV_DOCUMENT_PERMISSIONS_OK_TO_COPY 
EV_DOCUMENT_PERMISSIONS_OK_TO_ADD_NOTES 
EV_DOCUMENT_PERMISSIONS_FULL 

Definition at line 75 of file ev-document-info.h.

76 {
77  EV_DOCUMENT_PERMISSIONS_OK_TO_PRINT = 1 << 0,
78  EV_DOCUMENT_PERMISSIONS_OK_TO_MODIFY = 1 << 1,
79  EV_DOCUMENT_PERMISSIONS_OK_TO_COPY = 1 << 2,
80  EV_DOCUMENT_PERMISSIONS_OK_TO_ADD_NOTES = 1 << 3,
81  EV_DOCUMENT_PERMISSIONS_FULL = _PERMISSIONS_FULL
82 } EvDocumentPermissions;
enum EvDocumentUIHints
Enumerator
EV_DOCUMENT_UI_HINT_HIDE_TOOLBAR 
EV_DOCUMENT_UI_HINT_HIDE_MENUBAR 
EV_DOCUMENT_UI_HINT_HIDE_WINDOWUI 
EV_DOCUMENT_UI_HINT_FIT_WINDOW 
EV_DOCUMENT_UI_HINT_CENTER_WINDOW 
EV_DOCUMENT_UI_HINT_DISPLAY_DOC_TITLE 
EV_DOCUMENT_UI_HINT_DIRECTION_RTL 

Definition at line 58 of file ev-document-info.h.

59 {
60  EV_DOCUMENT_UI_HINT_HIDE_TOOLBAR = 1 << 0,
61  EV_DOCUMENT_UI_HINT_HIDE_MENUBAR = 1 << 1,
62  EV_DOCUMENT_UI_HINT_HIDE_WINDOWUI = 1 << 2,
63  EV_DOCUMENT_UI_HINT_FIT_WINDOW = 1 << 3,
64  EV_DOCUMENT_UI_HINT_CENTER_WINDOW = 1 << 4,
65  EV_DOCUMENT_UI_HINT_DISPLAY_DOC_TITLE = 1 << 5,
66  EV_DOCUMENT_UI_HINT_DIRECTION_RTL = 1 << 6
67 } EvDocumentUIHints;

Function Documentation

EvDocumentInfo* ev_document_info_copy ( EvDocumentInfo *  info)

Definition at line 1070 of file ev-document.c.

1071 {
1072  EvDocumentInfo *copy;
1073 
1074  g_return_val_if_fail (info != NULL, NULL);
1075 
1076  copy = g_new0 (EvDocumentInfo, 1);
1077  copy->title = g_strdup (info->title);
1078  copy->format = g_strdup (info->format);
1079  copy->author = g_strdup (info->author);
1080  copy->subject = g_strdup (info->subject);
1081  copy->keywords = g_strdup (info->keywords);
1082  copy->security = g_strdup (info->security);
1083  copy->creator = g_strdup (info->creator);
1084  copy->producer = g_strdup (info->producer);
1085  copy->linearized = g_strdup (info->linearized);
1086 
1087  copy->creation_date = info->creation_date;
1088  copy->modified_date = info->modified_date;
1089  copy->layout = info->layout;
1090  copy->mode = info->mode;
1091  copy->ui_hints = info->ui_hints;
1092  copy->permissions = info->permissions;
1093  copy->n_pages = info->n_pages;
1094  copy->license = ev_document_license_copy (info->license);
1095 
1096  copy->fields_mask = info->fields_mask;
1097 
1098  return copy;
1099 }
void ev_document_info_free ( EvDocumentInfo *  info)

Definition at line 1102 of file ev-document.c.

1103 {
1104  if (info == NULL)
1105  return;
1106 
1107  g_free (info->title);
1108  g_free (info->format);
1109  g_free (info->author);
1110  g_free (info->subject);
1111  g_free (info->keywords);
1112  g_free (info->creator);
1113  g_free (info->producer);
1114  g_free (info->linearized);
1115  g_free (info->security);
1116  ev_document_license_free (info->license);
1117 
1118  g_free (info);
1119 }

+ Here is the caller graph for this function:

GType ev_document_info_get_type ( void  )
EvDocumentLicense* ev_document_license_copy ( EvDocumentLicense *  license)

Definition at line 1131 of file ev-document.c.

1132 {
1133  EvDocumentLicense *new_license;
1134 
1135  if (!license)
1136  return NULL;
1137 
1138  new_license = ev_document_license_new ();
1139 
1140  if (license->text)
1141  new_license->text = g_strdup (license->text);
1142  if (license->uri)
1143  new_license->uri = g_strdup (license->uri);
1144  if (license->web_statement)
1145  new_license->web_statement = g_strdup (license->web_statement);
1146 
1147  return new_license;
1148 }

+ Here is the caller graph for this function:

void ev_document_license_free ( EvDocumentLicense *  license)

Definition at line 1151 of file ev-document.c.

1152 {
1153  if (!license)
1154  return;
1155 
1156  g_free (license->text);
1157  g_free (license->uri);
1158  g_free (license->web_statement);
1159 
1160  g_free (license);
1161 }

+ Here is the caller graph for this function:

const gchar* ev_document_license_get_text ( EvDocumentLicense *  license)

Definition at line 1164 of file ev-document.c.

1165 {
1166  return license->text;
1167 }

+ Here is the caller graph for this function:

GType ev_document_license_get_type ( void  )
const gchar* ev_document_license_get_uri ( EvDocumentLicense *  license)

Definition at line 1170 of file ev-document.c.

1171 {
1172  return license->uri;
1173 }

+ Here is the caller graph for this function:

const gchar* ev_document_license_get_web_statement ( EvDocumentLicense *  license)

Definition at line 1176 of file ev-document.c.

1177 {
1178  return license->web_statement;
1179 }

+ Here is the caller graph for this function:

EvDocumentLicense* ev_document_license_new ( void  )

Definition at line 1125 of file ev-document.c.

1126 {
1127  return g_new0 (EvDocumentLicense, 1);
1128 }

+ Here is the caller graph for this function: