[squirrelmail.git] / templates / default_advanced / read_menubar_nav.tpl

<?php
/**
 * read_menubar_nav.tpl
 *
 * Template to generate the nav buttons while reading a message, e.g. "Previous",
 * "Next", "Delete & Previous", etc.  When used in conjunction with the
 * read_menubar_nav tempalte, the entire menubar is generated.
 * 
 * The following variables are available in this template:
 *    $nav_on_top       - boolean TRUE if the navigation buttons are on top of the
 *                        action buttons generated here.
 *    $prev_href        - URL to move to the previous message.  Empty if not avilable.
 *    $up_href          - URL to move up in the message.  Empty if not available.
 *    $next_href    - URL to move to the next nessage.  Empty when N/A.
 *    $del_prev_href - URL to delete this message and move to the next one.  Empty if N/A.
 *    $del_next_href - URL to delete this message and move to the next one.  Empty if N/A.
 *    $view_msg_href - URL to go back to the main message.  Empty if N/A.
 *    $msg_list_href - URL to go to the message list.
 *    $search_href   - URL to go back to the serach results.  Empty if N/A.
 *    $form_extra    - Extra elements required by the forms to delete, move or copy
 *    $compose_href  - Base URL to forward, reply, etc.  Note that a specific action
 *                     must also be given by the form or in this URL.
 *    $on_click      - Onclick event string for all buttons
 *    $forward_as_attachment_enabled - boolean TRUE if forwarding as attachments
 *                     has been enabled.
 *    $can_resume_draft - boolean TRUE if the "resume draft" is legitimate for
 *                     this message.
 *    $can_edit_as_new - boolean TRUE if the "reasume as new" action is legitimate
 *                     for this message
 *    $mailboxes     - array containing list of mailboxes available for move/copy action.
 *    $can_be_deleted - boolean TRUE if this message can be deleted.
 *    $can_be_moved  - boolean TRUE if this message can be moved.
 *    $cab_be_copied - boolean TRUE if this message can be copied to another folder.
 *    $move_delete_form_action - the value for the ACTION attribute of forms to
 *                     move, copy or delete a message
 *    $delete_form_extra - additional input elements needed by the DELETE form
 *    $move_form_extra - additional input elements needed by the MOVE form.
 *    $last_move_target - the last folder that a message was moved/copied to. 
 *     *
 * @copyright &copy; 1999-2006 The SquirrelMail Project Team
 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
 * @version $Id: read_menubar_nav.tpl 11850 2006-10-06 21:57:26Z stevetruckstuff $
 * @package squirrelmail
 * @subpackage templates
 */

/** add required includes **/

/** extract template variables **/
extract($t);


/*FIXME: This is a place where Marc's idea for putting all the buttons and 
         links and other widgets into an array is sorely needed instead of
         hard-coding everything.  Whomever implements that, PLEASE, PLEASE
         look at how the preview pane plugin code is used here to change
         some links and buttons and make sure your implementation can support
         it (tip: it may or may not be OK to let a plugin do the modification
         of the widgets, since a template set can turn on the needed plugin,
         but that might not be the most clear way to solve said issue).*/


/** preview pane prep */
global $data_dir, $username, $base_uri;
$pp_refresh_message_list = getPref($data_dir, $username, 'pp_refresh_message_list', 1);
$use_previewPane = getPref($data_dir, $username, 'use_previewPane', 0);
$show_preview_pane = checkForJavascript() && $use_previewPane;
$empty_frame_uri = $base_uri . 'plugins/preview_pane/empty_frame.php';


/** Begin template **/

if ($nav_on_top) {
    $table_class = 'top';
    $plugin_hook = 'read_body_menu_nav_top';
} else {
    $table_class = 'bottom';
    $plugin_hook = 'read_body_menu_nav_bottom';
}
?>
<div class="readMenuBar">
<table cellspacing="0" class="<?php echo $table_class; ?>">
 <tr class="nav">
  <td class="nav">
   <small>
   [
   <?php
    if (empty($prev_href)) {
        echo _("Previous");
    } else {
        ?>
   <a href="<?php echo $prev_href; ?><?php

/** if preview pane turned on with "always refresh message list", 
    refresh message list frame too, but only if we are in the bottom frame! 
    and make sure the refresh is conditional upon the seen flag of the
    message after it is loaded (see read_headers.tpl) */
if ($show_preview_pane && $pp_refresh_message_list)
   // old code: unconditional refresh
   //echo ' onclick="if (self.name == \'bottom\') { refresh_message_list(); } "';
   echo '&amp;pp_rr=1';


echo '">' . _("Previous"); ?></a>
        <?php
    }
   ?> | 
   <?php
    if (empty($up_href)) {
        # Do nothing
    } else {
        ?>
   <a href="<?php echo $up_href; ?>"><?php echo _("Up"); ?></a> |
        <?php
    }

    if (empty($next_href)) {
        echo _("Next");
    } else {
        ?>
   <a href="<?php echo $next_href; ?><?php

/** if preview pane turned on with "always refresh message list", 
    refresh message list frame too, but only if we are in the bottom frame! 
    and make sure the refresh is conditional upon the seen flag of the
    message after it is loaded (see read_headers.tpl) */
if ($show_preview_pane && $pp_refresh_message_list)
   // old code: unconditional refresh
   //echo ' onclick="if (self.name == \'bottom\') { refresh_message_list(); } "';
   echo '&amp;pp_rr=1';


echo '">' . _("Next"); ?></a>
        <?php
    }
   ?>
   ]
   &nbsp;&nbsp;&nbsp;&nbsp;
   <?php
    if (!empty($del_prev_href) || !empty($del_next_href)) {
        ?>
        [
        <?php        
        if (empty($del_prev_href)) {
            echo _("Delete &amp; Previous");
        } else {
            ?>
   <a href="<?php echo $del_prev_href; ?>"<?php

/** if preview pane turned on with "always refresh message list", 
    refresh message list frame too, but only if we are in the bottom frame! */
if ($show_preview_pane && $pp_refresh_message_list)
   echo ' onclick="if (self.name == \'bottom\') { refresh_message_list(); } "';


echo '>' . _("Delete &amp; Previous"); ?></a>
            <?php
        }
        ?>
        | 
        <?php
        if (empty($del_next_href)) {
            echo _("Delete &amp; Next");
        } else {
            ?>
   <a href="<?php echo $del_next_href; ?>"<?php

/** if preview pane turned on with "always refresh message list", 
    refresh message list frame too, but only if we are in the bottom frame! */
if ($show_preview_pane && $pp_refresh_message_list)
   echo ' onclick="if (self.name == \'bottom\') { refresh_message_list(); } "';


echo '>' . _("Delete &amp; Next"); ?></a>
            <?php
        }
        ?>
        ]
   &nbsp;&nbsp;&nbsp;&nbsp;
        <?php
    }
   
    if (!empty($view_msg_href)) {
        ?>
   [ <a href="<?php echo $view_msg_href; ?>"><?php echo _("View Message"); ?></a> ]
   &nbsp;&nbsp;&nbsp;&nbsp;
        <?php
    }
   ?>
   [ <a href="<?php echo $message_list_href; ?>"<?php

/** if preview pane turned on, retarget to message list frame & clear 
    bottom frame, but only if we are in the bottom frame! */
if ($show_preview_pane)
   echo ' onclick="if (self.name == \'bottom\') { parent.right.document.location=\'' . $message_list_href . '\'; document.location=\'' . $empty_frame_uri . '\'; return false; } "';


echo '>' . _("Message List"); ?></a>
   <?php
    if (!empty($search_href)) {
        ?>
   | <a href="<?php echo $search_href; ?>"><?php echo _("Search Results"); ?></a>
        <?php
    }
   ?>
   ]
   </small>
   <?php if(!empty($plugin_output[$plugin_hook])) echo $plugin_output[$plugin_hook]; ?>
  </td>
 </tr>
</table>
</div>
Commit	Line	Data
505e00aa	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 © 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';
505e00aa	69
	70
	71	/ Begin template /
	72
	73	if ($nav_on_top) {
	74	$table_class = 'top';
	75	$plugin_hook = 'read_body_menu_nav_top';
	76	} else {
	77	$table_class = 'bottom';
	78	$plugin_hook = 'read_body_menu_nav_bottom';
	79	}
	80	?>
	81	<div class="readMenuBar">
	82	<table cellspacing="0" class="<?php echo $table_class; ?>">
	83	<tr class="nav">
	84	<td class="nav">
	85	<small>
	86	[
	87	<?php
	88	if (empty($prev_href)) {
	89	echo _("Previous");
	90	} else {
	91	?>
010ff205	92	<a href="<?php echo $prev_href; ?><?php
505e00aa	93
505e00aa	94	/** if preview pane turned on with "always refresh message list",
010ff205	95	refresh message list frame too, but only if we are in the bottom frame!
	96	and make sure the refresh is conditional upon the seen flag of the
	97	message after it is loaded (see read_headers.tpl) */
505e00aa	98	if ($show_preview_pane && $pp_refresh_message_list)
010ff205	99	// old code: unconditional refresh
	100	//echo ' onclick="if (self.name == \'bottom\') { refresh_message_list(); } "';
	101	echo '&pp_rr=1';
505e00aa	102
505e00aa	103
010ff205	104	echo '">' . _("Previous"); ?></a>
505e00aa	105	<?php
	106	}
	107	?> \|
	108	<?php
	109	if (empty($up_href)) {
	110	# Do nothing
	111	} else {
	112	?>
	113	<a href="<?php echo $up_href; ?>"><?php echo _("Up"); ?></a> \|
	114	<?php
	115	}
	116
	117	if (empty($next_href)) {
	118	echo _("Next");
	119	} else {
	120	?>
010ff205	121	<a href="<?php echo $next_href; ?><?php
505e00aa	122
505e00aa	123	/** if preview pane turned on with "always refresh message list",
010ff205	124	refresh message list frame too, but only if we are in the bottom frame!
	125	and make sure the refresh is conditional upon the seen flag of the
	126	message after it is loaded (see read_headers.tpl) */
505e00aa	127	if ($show_preview_pane && $pp_refresh_message_list)
010ff205	128	// old code: unconditional refresh
	129	//echo ' onclick="if (self.name == \'bottom\') { refresh_message_list(); } "';
	130	echo '&pp_rr=1';
505e00aa	131
505e00aa	132
010ff205	133	echo '">' . _("Next"); ?></a>
505e00aa	134	<?php
	135	}
	136	?>
	137	]
	138
	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 & 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 & Previous"); ?></a>
	157	<?php
	158	}
	159	?>
	160	\|
	161	<?php
	162	if (empty($del_next_href)) {
	163	echo _("Delete & 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 & Next"); ?></a>
	175	<?php
	176	}
	177	?>
	178	]
	179
	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
	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>