Home | News | Projects | Releases
Bugs | RFE | Repositories | Help
Commit of recent work in preperation for Kiriwrite 0.5.0
[kiriwrite/.git] / Documentation / English (British) / developer-chapter4-getoptions.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\r
2 <html>\r
3         <head>\r
4                 <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
5                 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
6                 <title>Kiriwrite Documentation - Developer Documentation - 4.5: getoptions</title>\r
7         </head>\r
8         <body>\r
9                 <div class="menubarback">\r
10                         <div class="menubar">\r
11                                 <span class="apptitle">Kiriwrite</span>\r
12                                 <a href="index.html">Index</a> | <a href="user.html">User \r
13 Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> | \r
14 <a href="developer.html">Developer Documentation</a>\r
15                         </div>\r
16                 </div>\r
17                 <div class="pageinformation">\r
18                         <span class="pagetitle">4.5 getoptions</span><br><br>\r
19 \r
20 Gets the options that will be used in the compile pages confirmation screen.<br><br>\r
21 \r
22 <span class="heading">Parameters:</span><br><br>\r
23 \r
24 <div class="code">\r
25     $kiriwrite_outputmodule->getoptions();\r
26 </div>\r
27 \r
28 <br>\r
29 \r
30 <span class="heading">Usage:</span><br><br>\r
31 \r
32 <div class="code">\r
33     %options = $kiriwrite_outputmodule->getoptions();\r
34 </div>\r
35 \r
36 <br>\r
37 \r
38 In the getoptions subroutine, you build a hash up which is to be returned when the subroutine is finished.<br><br>\r
39 \r
40 <div class="code">\r
41     $options{seperatedirdatabase}{type} = &quot;checkbox&quot;;<br>\r
42     $options{seperatedirdatabase}{string} = languagestrings(&quot;seperatedirdatabase&quot;);\r
43 </div>\r
44 \r
45 <br>\r
46 \r
47 After the internal name of the option, you specify the type of option (and the options that go with that type of option):<br><br>\r
48 \r
49 checkbox<br>\r
50 Specifies that a checkbox should be added.<br><br>\r
51 \r
52 <table class="infotable">\r
53     <tr>\r
54         <td class="tableheading">Value</td>\r
55         <td class="tableheading">Description</td>\r
56     </tr>\r
57     <tr>\r
58         <td class="tabledata">string</td>\r
59         <td class="tabledata">Specifies the description for the option.</td>\r
60     </tr>\r
61 </table>\r
62 \r
63 <br>\r
64 \r
65 textbox<br>\r
66 Specifies that a text box should be added.<br><br>\r
67 \r
68 <table class="infotable">\r
69     <tr>\r
70         <td class="tableheading">Value</td>\r
71         <td class="tableheading">Description</td>\r
72     </tr>\r
73     <tr>\r
74         <td class="tabledata">string</td>\r
75         <td class="tabledata">Specifies the description for the text box.</td>\r
76     </tr>\r
77     <tr>\r
78         <td class="tabledata">value</td>\r
79         <td class="tabledata">Specifies the default value of the text box.</td>\r
80     </tr>\r
81     <tr>\r
82         <td class="tabledata">size</td>\r
83         <td class="tabledata">Specifies the size of the text box.</td>\r
84     </tr>\r
85     <tr>\r
86         <td class="tabledata">maxlength</td>\r
87         <td class="tabledata">Specifies the maximum size of the value.</td>\r
88     </tr>\r
89     <tr>\r
90         <td class="tabledata">password</td>\r
91         <td class="tabledata">Specifies the text box is a password box.</td>\r
92     </tr>\r
93 </table>\r
94 \r
95 <br>\r
96 \r
97 combobox<br>\r
98 Specifies that a drop down box should be added.<br><br>\r
99 \r
100 <table class="infotable">\r
101     <tr>\r
102         <td class="tableheading">Value</td>\r
103         <td class="tableheading">Description</td>\r
104     </tr>\r
105     <tr>\r
106         <td class="tabledata">optionnames</td>\r
107         <td class="tabledata">The names for the options in the drop down box with each name separated by a pipe ( | )</td>\r
108     </tr>\r
109     <tr>\r
110         <td class="tabledata">optionvalues</td>\r
111         <td class="tabledata">The values for the options in the drop down box with each value separated by a pipe. ( | )</td>\r
112     </tr>\r
113     <tr>\r
114         <td class="tabledata">string</td>\r
115         <td class="tabledata">Specifies the string to provide a description of the drop down box.</td>\r
116     </tr>\r
117 </table>\r
118 \r
119 <br>\r
120 \r
121 radio<br>\r
122 Specifies that a option button should be added.<br><br>\r
123 \r
124 <table class="infotable">\r
125     <tr>\r
126         <td class="tableheading">Value</td>\r
127         <td class="tableheading">Description</td>\r
128     </tr>\r
129     <tr>\r
130         <td class="tabledata">StartFrom</td>\r
131         <td class="tabledata">Specifies which filter entry to start from.</td>\r
132     </tr>\r
133     <tr>\r
134         <td class="tabledata">Limit</td>\r
135         <td class="tabledata">Specifies how many filters should be retrieved.</td>\r
136     </tr>\r
137 </table>\r
138                 </div>\r
139         </body>\r
140 </html>\r
Xestia Software Development
Yn Maystri
© 2006 - 2019 Xestia Software Development
Software

Xestia Address Book
Xestia Calendar
Development

Xestia Gelforn
Everything else

About
News
Privacy Policy