Add preview pane to advanced default template. This serves as an example of how...
[squirrelmail.git] / templates / default_advanced / read_menubar_nav.tpl
1 <?php
2 /**
3  * read_menubar_nav.tpl
4  *
5  * Template to generate the nav buttons while reading a message, e.g. "Previous",
6  * "Next", "Delete & Previous", etc.  When used in conjunction with the
7  * read_menubar_nav tempalte, the entire menubar is generated.
8  * 
9  * The following variables are available in this template:
10  *    $nav_on_top       - boolean TRUE if the navigation buttons are on top of the
11  *                        action buttons generated here.
12  *    $prev_href        - URL to move to the previous message.  Empty if not avilable.
13  *    $up_href          - URL to move up in the message.  Empty if not available.
14  *    $next_href    - URL to move to the next nessage.  Empty when N/A.
15  *    $del_prev_href - URL to delete this message and move to the next one.  Empty if N/A.
16  *    $del_next_href - URL to delete this message and move to the next one.  Empty if N/A.
17  *    $view_msg_href - URL to go back to the main message.  Empty if N/A.
18  *    $msg_list_href - URL to go to the message list.
19  *    $search_href   - URL to go back to the serach results.  Empty if N/A.
20  *    $form_extra    - Extra elements required by the forms to delete, move or copy
21  *    $compose_href  - Base URL to forward, reply, etc.  Note that a specific action
22  *                     must also be given by the form or in this URL.
23  *    $on_click      - Onclick event string for all buttons
24  *    $forward_as_attachment_enabled - boolean TRUE if forwarding as attachments
25  *                     has been enabled.
26  *    $can_resume_draft - boolean TRUE if the "resume draft" is legitimate for
27  *                     this message.
28  *    $can_edit_as_new - boolean TRUE if the "reasume as new" action is legitimate
29  *                     for this message
30  *    $mailboxes     - array containing list of mailboxes available for move/copy action.
31  *    $can_be_deleted - boolean TRUE if this message can be deleted.
32  *    $can_be_moved  - boolean TRUE if this message can be moved.
33  *    $cab_be_copied - boolean TRUE if this message can be copied to another folder.
34  *    $move_delete_form_action - the value for the ACTION attribute of forms to
35  *                     move, copy or delete a message
36  *    $delete_form_extra - additional input elements needed by the DELETE form
37  *    $move_form_extra - additional input elements needed by the MOVE form.
38  *    $last_move_target - the last folder that a message was moved/copied to. 
39  *     *
40  * @copyright &copy; 1999-2006 The SquirrelMail Project Team
41  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
42  * @version $Id: read_menubar_nav.tpl 11850 2006-10-06 21:57:26Z stevetruckstuff $
43  * @package squirrelmail
44  * @subpackage templates
45  */
46
47 /** add required includes **/
48
49 /** extract template variables **/
50 extract($t);
51
52
53 /*FIXME: This is a place where Marc's idea for putting all the buttons and 
54          links and other widgets into an array is sorely needed instead of
55          hard-coding everything.  Whomever implements that, PLEASE, PLEASE
56          look at how the preview pane plugin code is used here to change
57          some links and buttons and make sure your implementation can support
58          it (tip: it may or may not be OK to let a plugin do the modification
59          of the widgets, since a template set can turn on the needed plugin,
60          but that might not be the most clear way to solve said issue).*/
61
62
63 /** preview pane prep */
64 global $data_dir, $username, $base_uri;
65 $pp_refresh_message_list = getPref($data_dir, $username, 'pp_refresh_message_list', 1);
66 $use_previewPane = getPref($data_dir, $username, 'use_previewPane', 0);
67 $show_preview_pane = checkForJavascript() && $use_previewPane;
68 $empty_frame_uri = $base_uri . 'plugins/preview_pane/empty_frame.php';
69 if ($show_preview_pane) { ?>
70    <script>
71    <!--
72       function refresh_message_list()
73       { parent.right.delayed_page_load("<?php echo $message_list_href; ?>"); }
74    // -->
75    </script>
76 <?php }
77
78
79 /** Begin template **/
80
81 if ($nav_on_top) {
82     $table_class = 'top';
83     $plugin_hook = 'read_body_menu_nav_top';
84 } else {
85     $table_class = 'bottom';
86     $plugin_hook = 'read_body_menu_nav_bottom';
87 }
88 ?>
89 <div class="readMenuBar">
90 <table cellspacing="0" class="<?php echo $table_class; ?>">
91  <tr class="nav">
92   <td class="nav">
93    <small>
94    [
95    <?php
96     if (empty($prev_href)) {
97         echo _("Previous");
98     } else {
99         ?>
100    <a href="<?php echo $prev_href; ?>"<?php
101
102 /** if preview pane turned on with "always refresh message list", 
103     refresh message list frame too, but only if we are in the bottom frame! */
104 if ($show_preview_pane && $pp_refresh_message_list)
105    echo ' onclick="if (self.name == \'bottom\') { refresh_message_list(); } "';
106
107
108 echo '>' . _("Previous"); ?></a>
109         <?php
110     }
111    ?> | 
112    <?php
113     if (empty($up_href)) {
114         # Do nothing
115     } else {
116         ?>
117    <a href="<?php echo $up_href; ?>"><?php echo _("Up"); ?></a> |
118         <?php
119     }
120
121     if (empty($next_href)) {
122         echo _("Next");
123     } else {
124         ?>
125    <a href="<?php echo $next_href; ?>"<?php
126
127 /** if preview pane turned on with "always refresh message list", 
128     refresh message list frame too, but only if we are in the bottom frame! */
129 if ($show_preview_pane && $pp_refresh_message_list)
130    echo ' onclick="if (self.name == \'bottom\') { refresh_message_list(); } "';
131
132
133 echo '>' . _("Next"); ?></a>
134         <?php
135     }
136    ?>
137    ]
138    &nbsp;&nbsp;&nbsp;&nbsp;
139    <?php
140     if (!empty($del_prev_href) || !empty($del_next_href)) {
141         ?>
142         [
143         <?php        
144         if (empty($del_prev_href)) {
145             echo _("Delete &amp; Previous");
146         } else {
147             ?>
148    <a href="<?php echo $del_prev_href; ?>"<?php
149
150 /** if preview pane turned on with "always refresh message list", 
151     refresh message list frame too, but only if we are in the bottom frame! */
152 if ($show_preview_pane && $pp_refresh_message_list)
153    echo ' onclick="if (self.name == \'bottom\') { refresh_message_list(); } "';
154
155
156 echo '>' . _("Delete &amp; Previous"); ?></a>
157             <?php
158         }
159         ?>
160         | 
161         <?php
162         if (empty($del_next_href)) {
163             echo _("Delete &amp; Next");
164         } else {
165             ?>
166    <a href="<?php echo $del_next_href; ?>"<?php
167
168 /** if preview pane turned on with "always refresh message list", 
169     refresh message list frame too, but only if we are in the bottom frame! */
170 if ($show_preview_pane && $pp_refresh_message_list)
171    echo ' onclick="if (self.name == \'bottom\') { refresh_message_list(); } "';
172
173
174 echo '>' . _("Delete &amp; Next"); ?></a>
175             <?php
176         }
177         ?>
178         ]
179    &nbsp;&nbsp;&nbsp;&nbsp;
180         <?php
181     }
182    
183     if (!empty($view_msg_href)) {
184         ?>
185    [ <a href="<?php echo $view_msg_href; ?>"><?php echo _("View Message"); ?></a> ]
186    &nbsp;&nbsp;&nbsp;&nbsp;
187         <?php
188     }
189    ?>
190    [ <a href="<?php echo $message_list_href; ?>"<?php
191
192 /** if preview pane turned on, retarget to message list frame & clear 
193     bottom frame, but only if we are in the bottom frame! */
194 if ($show_preview_pane)
195    echo ' onclick="if (self.name == \'bottom\') { parent.right.document.location=\'' . $message_list_href . '\'; document.location=\'' . $empty_frame_uri . '\'; return false; } "';
196
197
198 echo '>' . _("Message List"); ?></a>
199    <?php
200     if (!empty($search_href)) {
201         ?>
202    | <a href="<?php echo $search_href; ?>"><?php echo _("Search Results"); ?></a>
203         <?php
204     }
205    ?>
206    ]
207    </small>
208    <?php if(!empty($plugin_output[$plugin_hook])) echo $plugin_output[$plugin_hook]; ?>
209   </td>
210  </tr>
211 </table>
212 </div>