6 * Displays all options concerning composing of new messages
8 * @copyright © 1999-2006 The SquirrelMail Project Team
9 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
11 * @package squirrelmail
14 /** Define the group constants for this options page. */
15 define('SMOPT_GRP_COMPOSE', 0);
16 define('SMOPT_GRP_COMPOSE_REPLY', 1);
19 * This function builds an array with all the information about
20 * the options available to the user, and returns it. The options
21 * are grouped by the groups in which they are displayed.
22 * For each option, the following information is stored:
23 * - name: the internal (variable) name
24 * - caption: the description of the option in the UI
25 * - type: one of SMOPT_TYPE_*
26 * - refresh: one of SMOPT_REFRESH_*
27 * - size: one of SMOPT_SIZE_*
28 * - save: the name of a function to call when saving this option
29 * @return array all option information
31 function load_optpage_data_compose() {
33 /* Build a simple array into which we will build options. */
37 /******************************************************/
38 /* LOAD EACH GROUP OF OPTIONS INTO THE OPTIONS ARRAY. */
39 /******************************************************/
41 /*** Load the General Compose Options into the array ***/
42 $optgrps[SMOPT_GRP_COMPOSE
] = _("General Message Composition");
43 $optvals[SMOPT_GRP_COMPOSE
] = array();
45 $optvals[SMOPT_GRP_COMPOSE
][] = array(
46 'name' => 'editor_size',
47 'caption' => _("Width of Editor Window"),
48 'type' => SMOPT_TYPE_INTEGER
,
49 'refresh' => SMOPT_REFRESH_NONE
,
50 'size' => SMOPT_SIZE_TINY
53 $optvals[SMOPT_GRP_COMPOSE
][] = array(
54 'name' => 'editor_height',
55 'caption' => _("Height of Editor Window"),
56 'type' => SMOPT_TYPE_INTEGER
,
57 'refresh' => SMOPT_REFRESH_NONE
,
58 'size' => SMOPT_SIZE_TINY
61 $optvals[SMOPT_GRP_COMPOSE
][] = array(
62 'name' => 'location_of_buttons',
63 'caption' => _("Location of Buttons when Composing"),
64 'type' => SMOPT_TYPE_STRLIST
,
65 'refresh' => SMOPT_REFRESH_NONE
,
66 'posvals' => array(SMPREF_LOC_TOP
=> _("Before headers"),
67 SMPREF_LOC_BETWEEN
=> _("Between headers and message body"),
68 SMPREF_LOC_BOTTOM
=> _("After message body"))
72 $optvals[SMOPT_GRP_COMPOSE
][] = array(
73 'name' => 'use_javascript_addr_book',
74 'caption' => _("Addressbook Display Format"),
75 'type' => SMOPT_TYPE_STRLIST
,
76 'refresh' => SMOPT_REFRESH_NONE
,
77 'posvals' => array('1' => _("Javascript"),
82 $optvals[SMOPT_GRP_COMPOSE
][] = array(
83 'name' => 'compose_new_win',
84 'caption' => _("Compose Messages in New Window"),
85 'type' => SMOPT_TYPE_BOOLEAN
,
86 'refresh' => SMOPT_REFRESH_ALL
89 $optvals[SMOPT_GRP_COMPOSE
][] = array(
90 'name' => 'compose_width',
91 'caption' => _("Width of Compose Window"),
92 'type' => SMOPT_TYPE_INTEGER
,
93 'refresh' => SMOPT_REFRESH_ALL
,
94 'size' => SMOPT_SIZE_TINY
97 $optvals[SMOPT_GRP_COMPOSE
][] = array(
98 'name' => 'compose_height',
99 'caption' => _("Height of Compose Window"),
100 'type' => SMOPT_TYPE_INTEGER
,
101 'refresh' => SMOPT_REFRESH_ALL
,
102 'size' => SMOPT_SIZE_TINY
106 /*** Load the General Options into the array ***/
107 $optgrps[SMOPT_GRP_COMPOSE_REPLY
] = _("Replying and Forwarding Messages");
108 $optvals[SMOPT_GRP_COMPOSE_REPLY
] = array();
110 $optvals[SMOPT_GRP_COMPOSE_REPLY
][] = array(
111 'name' => 'forward_cc',
112 'caption' => _("Include CCs when Forwarding Messages"),
113 'type' => SMOPT_TYPE_BOOLEAN
,
114 'refresh' => SMOPT_REFRESH_NONE
117 $optvals[SMOPT_GRP_COMPOSE_REPLY
][] = array(
118 'name' => 'include_self_reply_all',
119 'caption' => _("Include Me in CC when I Reply All"),
120 'type' => SMOPT_TYPE_BOOLEAN
,
121 'refresh' => SMOPT_REFRESH_NONE
124 $optvals[SMOPT_GRP_COMPOSE_REPLY
][] = array(
125 'name' => 'sig_first',
126 'caption' => _("Prepend Signature before Reply/Forward Text"),
127 'type' => SMOPT_TYPE_BOOLEAN
,
128 'refresh' => SMOPT_REFRESH_NONE
131 $optvals[SMOPT_GRP_COMPOSE_REPLY
][] = array(
132 'name' => 'body_quote',
133 'caption' => _("Prefix for Original Message when Replying"),
134 'type' => SMOPT_TYPE_STRING
,
135 'refresh' => SMOPT_REFRESH_NONE
,
136 'size' => SMOPT_SIZE_TINY
,
137 'save' => 'save_option_reply_prefix'
140 $optvals[SMOPT_GRP_COMPOSE_REPLY
][] = array(
141 'name' => 'reply_focus',
142 'caption' => _("Cursor Position when Replying"),
143 'type' => SMOPT_TYPE_STRLIST
,
144 'refresh' => SMOPT_REFRESH_NONE
,
145 'posvals' => array('' => _("To: field"),
146 'focus' => _("Focus in body"),
147 'select' => _("Select body"),
148 'none' => _("No focus"))
151 $optvals[SMOPT_GRP_COMPOSE_REPLY
][] = array(
152 'name' => 'strip_sigs',
153 'caption' => _("Strip signature when replying"),
154 'type' => SMOPT_TYPE_BOOLEAN
,
155 'refresh' => SMOPT_REFRESH_NONE
158 /* Assemble all this together and return it as our result. */
166 /******************************************************************/
167 /** Define any specialized save functions for this option page. ***/
169 /** You must add every function that is set in save parameter ***/
170 /******************************************************************/
173 * This function saves the reply prefix (body_quote) character(s)
174 * @param object $option
176 function save_option_reply_prefix($option) {
178 // save as "NONE" if it was blanked out
180 if (empty($option->new_value
)) $option->new_value
= 'NONE';
183 // Save the option like normal.
185 save_option($option);