summaryrefslogtreecommitdiff
path: root/support/dktools/dk3paper.h
blob: 66a8f75ad043003b01a6a626c1eb8c65d49f9a0e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/*
Copyright (C) 2011-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk3paper.ctr
*/

/**	@file dk3paper.h Header file for the dk3paper module.
*/

#ifndef DK3PAPER_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK3PAPER_H_INCLUDED 1


#line 10 "dk3paper.ctr"

#ifdef __cplusplus
extern "C" {
#endif

/**	Create paper sizes collection, read dk3paper.conf files.
	@param	app	Application structure for diagnostics and file search,
			must not be NULL.
	@return	Pointer to new collection on success, NULL on error.
*/
dk3_paper_size_collection_t *
dk3paper_open_app(dk3_app_t *app);

/**	Find paper size by name.
	@param	psc	Paper size collection.
	@param	psn	Paper size name.
	@return	Pointer to paper size on success, NULL on error.
*/
dk3_paper_size_t const *
dk3paper_find(dk3_paper_size_collection_t *psc, dkChar const *psn);

/**	Close paper size collection, release memory.
	@param	psc	Collection to close.
*/
void
dk3paper_close(dk3_paper_size_collection_t *psc);

/**	Prepare traversing the paper size collection for named paper sizes.
	@param	psc	Paper size collection.
*/
void
dk3paper_reset(dk3_paper_size_collection_t *psc);

/**	Retrieve next named paper size from size collection.
	@param	psc	Paper size collection.
	@return	Pointer to named paper size on success, NULL on error/end.
*/
dk3_named_paper_size_t const *
dk3paper_next(dk3_paper_size_collection_t *psc);

#ifdef __cplusplus
}
#endif




#endif