X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;ds=sidebyside;f=docs%2Flibglabels%2Fhtml%2Flibglabels-3.0-paper.html;fp=docs%2Flibglabels%2Fhtml%2Flibglabels-3.0-paper.html;h=bda48d815d5c22125a85c6e8d314f7ea7cc3c7c4;hb=8e4c50283c4f353b18c68474f91209b8bd050557;hp=b7f03da2a47ce6ab5ebdb77c0ccf5394c089fc1f;hpb=bf6d7db22a79d11630454dcd2e867764e89ca9fe;p=glabels diff --git a/docs/libglabels/html/libglabels-3.0-paper.html b/docs/libglabels/html/libglabels-3.0-paper.html index b7f03da2..bda48d81 100644 --- a/docs/libglabels/html/libglabels-3.0-paper.html +++ b/docs/libglabels/html/libglabels-3.0-paper.html @@ -2,30 +2,27 @@
-- | - | - | LibGlabels 3.0 Reference Manual | -- |
---|---|---|---|---|
-Top - Â |Â - Description - |
+Top + | ++ | + | + | + |
-#include <libglabels/lgl-paper.h> - -struct lglPaper; -lglPaper * lgl_paper_new (gchar *id
, -gchar *name
, -gdouble width
, -gdouble height
, -gchar *pwg_size
); -lglPaper * lgl_paper_dup (const lglPaper *orig
); -void lgl_paper_free (lglPaper *paper
); +++ + +Functions
+++
+ + ++ + + ++lglPaper * + ++lgl_paper_new () + ++ ++lglPaper * + ++lgl_paper_dup () + ++ + ++void + ++lgl_paper_free () + +@@ -58,129 +98,167 @@ and related functions.-Details
+Functions
-struct lglPaper
-struct lglPaper { - gchar *id; /* Unique ID of paper definition */ - gchar *name; /* Localized name of paper */ - gdouble width; /* Width (in points) */ - gdouble height; /* Height (in points) */ - gchar *pwg_size; /* PWG 5101.1-2002 size name */ -}; ---This structure defines a paper (page) size. -
--
+ lgl_paper_new ()
+lglPaper * +lgl_paper_new (+gchar *id
, +gchar *name
, +gdouble width
, +gdouble height
, +gchar *pwg_size
);Allocates and constructs a new lglPaper structure.
+++ +Parameters
++
+ + + + - - gchar *
id
;Paper size ID. ++ id
+ Id of paper definition. (E.g. US-Letter, A4, etc.) Should be +unique.
 - - gchar *
name
;Localized paper size name. ++ name
+ Localized name of paper.
 - - gdoubleÂ
width
;Width of paper in points. ++ width
+ Width of paper in points.
 - - gdoubleÂ
height
;Height of paper in points. ++ height
+ Height of paper in points.
 - - gchar *
pwg_size
;Paper size string as defined in PWG 5101.1-2002. ++ pwg_size
+ PWG 5101.1-2002 size name.
Â
-+lgl_paper_new ()
-lglPaper * lgl_paper_new (+gchar *id
, -gchar *name
, -gdouble width
, -gdouble height
, -gchar *pwg_size
);lgl_paper_dup ()
+lglPaper * +lgl_paper_dup (+const lglPaper *orig
);Duplicates an existing lglPaper structure.
+ + +
+++ +lgl_paper_free ()
+void +lgl_paper_free (+lglPaper *paper
);Free all memory associated with an existing lglPaper structure.
+ ++Types and Values
++struct lglPaper
+struct lglPaper { + gchar *id; /* Unique ID of paper definition */ + gchar *name; /* Localized name of paper */ + gdouble width; /* Width (in points) */ + gdouble height; /* Height (in points) */ + gchar *pwg_size; /* PWG 5101.1-2002 size name */ +}; +-Allocates and constructs a new lglPaper structure. +This structure defines a paper (page) size.
--
+ +-Members
+-+
+ + + + - --
id
 :Id of paper definition. (E.g. US-Letter, A4, etc.) Should be -unique. -- -
name
 :Localized name of paper. ++ gchar *
id
;+ Paper size ID.
 - -
width
 :Width of paper in points. ++ gchar *
name
;+ Localized paper size name.
 - -
height
 :Height of paper in points. ++ gdoubleÂ
width
;+ Width of paper in points.
 - --
pwg_size
 :PWG 5101.1-2002 size name. -- - -- Returns :
a pointer to a newly allocated lglPaper structure. -
---lgl_paper_dup ()
-lglPaper * lgl_paper_dup (-const lglPaper *orig
);-Duplicates an existing lglPaper structure. -
-
- + Generated by GTK-Doc V1.20 \ No newline at end of file