include/options/compose.php

   1 <?php
   2
   3 /**
   4  * options_compose.php
   5  *
   6  * Displays all options concerning composing of new messages
   7  *
   8  * @copyright &copy; 1999-2007 The SquirrelMail Project Team
   9  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10  * @version $Id$
  11  * @package squirrelmail
  12  */
  13
  14 /** Define the group constants for this options page. */
  15 define('SMOPT_GRP_COMPOSE', 0);
  16 define('SMOPT_GRP_COMPOSE_REPLY', 1);
  17
  18 /**
  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
  30  */
  31 function load_optpage_data_compose() {
  32
  33     /* Build a simple array into which we will build options. */
  34     $optgrps = array();
  35     $optvals = array();
  36
  37     /******************************************************/
  38     /* LOAD EACH GROUP OF OPTIONS INTO THE OPTIONS ARRAY. */
  39     /******************************************************/
  40
  41     /*** Load the General Compose Options into the array ***/
  42     $optgrps[SMOPT_GRP_COMPOSE] = _("General Message Composition");
  43     $optvals[SMOPT_GRP_COMPOSE] = array();
  44
  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
  51     );
  52
  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
  59     );
  60
  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"))
  69     );
  70
  71
  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"),
  78                            '0' => _("HTML"))
  79     );
  80
  81
  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
  87     );
  88
  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
  95     );
  96
  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
 103     );
 104
 105
 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();
 109
 110     $optvals[SMOPT_GRP_COMPOSE_REPLY][] = array(
 111         'name'    => 'include_self_reply_all',
 112         'caption' => _("Include Me in CC when I Reply All"),
 113         'type'    => SMOPT_TYPE_BOOLEAN,
 114         'refresh' => SMOPT_REFRESH_NONE
 115     );
 116
 117     $optvals[SMOPT_GRP_COMPOSE_REPLY][] = array(
 118         'name'    => 'sig_first',
 119         'caption' => _("Prepend Signature before Reply/Forward Text"),
 120         'type'    => SMOPT_TYPE_BOOLEAN,
 121         'refresh' => SMOPT_REFRESH_NONE
 122     );
 123
 124     $optvals[SMOPT_GRP_COMPOSE_REPLY][] = array(
 125         'name'    => 'body_quote',
 126         'caption' => _("Prefix for Original Message when Replying"),
 127         'type'    => SMOPT_TYPE_STRING,
 128         'refresh' => SMOPT_REFRESH_NONE,
 129         'size'    => SMOPT_SIZE_TINY,
 130         'save'    => 'save_option_reply_prefix'
 131     );
 132
 133     $optvals[SMOPT_GRP_COMPOSE_REPLY][] = array(
 134         'name'    => 'reply_focus',
 135         'caption' => _("Cursor Position when Replying"),
 136         'type'    => SMOPT_TYPE_STRLIST,
 137         'refresh' => SMOPT_REFRESH_NONE,
 138         'posvals' => array('' => _("To: field"),
 139                            'focus' => _("Focus in body"),
 140                            'select' => _("Select body"),
 141                            'none' => _("No focus"))
 142     );
 143
 144     $optvals[SMOPT_GRP_COMPOSE_REPLY][] = array(
 145         'name'    => 'strip_sigs',
 146         'caption' => _("Strip signature when replying"),
 147         'type'    => SMOPT_TYPE_BOOLEAN,
 148         'refresh' => SMOPT_REFRESH_NONE
 149     );
 150
 151     /* Assemble all this together and return it as our result. */
 152     $result = array(
 153         'grps' => $optgrps,
 154         'vals' => $optvals
 155     );
 156     return ($result);
 157 }
 158
 159 /******************************************************************/
 160 /** Define any specialized save functions for this option page. ***/
 161 /**                                                             ***/
 162 /** You must add every function that is set in save parameter   ***/
 163 /******************************************************************/
 164
 165 /**
 166  * This function saves the reply prefix (body_quote) character(s)
 167  * @param object $option
 168  */
 169 function save_option_reply_prefix($option) {
 170
 171     // save as "NONE" if it was blanked out
 172     //
 173     if (empty($option->new_value)) $option->new_value = 'NONE';
 174
 175
 176     // Save the option like normal.
 177     //
 178     save_option($option);
 179
 180 }