Added: desktop/trunk/Writer/lib/actions.class.php (27 => 28)

--- desktop/trunk/Writer/lib/actions.class.php	2006-11-02 19:21:50 UTC (rev 27)
+++ desktop/trunk/Writer/lib/actions.class.php	2006-11-30 15:15:17 UTC (rev 28)
@@ -0,0 +1,210 @@
+<?php
+/**
+ * actions.class.php - container for gtkactions & gtkactiongroups
+ *
+ * sets up actions and actiongroups "on demand"
+ *
+ * This is released under the GPL, see license.txt for details
+ *
+ * @author       Elizabeth Smith <emsmith@callicore.net>
+ * @copyright    Elizabeth Smith (c)2006
+ * @link         http://callicore.net/writer
+ * @license      http://www.opensource.org/licenses/gpl-license.php GPL
+ * @version      $Id$
+ * @since        Php 5.2.0
+ * @package      callicore
+ * @subpackage   writer
+ * @category     lib
+ * @filesource
+ */
+
+/**
+ * Actions - actions/actiongroups map
+ *
+ * fixes the weirdness of toolbar tooltips, adds help tooltip support
+ * and generally makes managing actions easier
+ */
+class Actions
+{
+
+	/**
+	 * list of all current created action groups
+	 * @var $groups array
+	 */
+	protected $groups = array();
+
+	/**
+	 * global accelerator container for actions
+	 * @var $accel instanceof GtkAccelGroup
+	 */
+	protected $accel;
+
+	/**
+	 * public function __construct
+	 *
+	 * sets up the global accelgroup
+	 *
+	 * @return void
+	 */
+	public function __construct()
+	{
+		$this->accel = new GtkAccelGroup();
+		return;
+	}
+
+	/**
+	 * public function get_accel
+	 *
+	 * returns GtkAccelGroup instance, use this to set it in the right window
+	 *
+	 * @return object instanceof GtkAccelGroup
+	 */
+	public function get_accel()
+	{
+		return $this->accel;
+	}
+
+	/**
+	 * public function create_menu_item
+	 *
+	 * uses get_group to fetch the action group specified
+	 * uses get_action to fetch the action specified
+	 * creates a menu item and sets a tooltip for the action
+	 *
+	 * @param string $group name of action group to get
+	 * @param string $action name of action to get
+	 * @return object instanceof GtkMenuItem
+	 */
+	public function create_menu_item($group, $action)
+	{
+		$action = $this->get_action($group, $action);
+		$widget = $action->create_menu_item();
+		Writer::$tooltips->set_tip($widget, $action->get_property('tooltip'), $action->get_data('help-tooltip'));
+		unset($action, $group);
+		return $widget;
+	}
+
+	/**
+	 * public function create_tool_item
+	 *
+	 * uses get_group to fetch the action group specified
+	 * uses get_action to fetch the action specified
+	 * creates a toolbar item and sets a tooltip for the action
+	 *
+	 * @param string $group name of action group to get
+	 * @param string $action name of action to get
+	 * @return object instanceof GtkToolItem
+	 */
+	public function create_tool_item($group, $action)
+	{
+		$action = $this->get_action($group, $action);
+		$widget = $action->create_tool_item();
+		Writer::$tooltips->set_tip($widget, $action->get_property('tooltip'), $action->get_data('help-tooltip'));
+		unset($action, $group);
+		return $widget;
+	}
+
+	/**
+	 * public function get_group
+	 *
+	 * returns action group
+	 *
+	 * @param string $group name of action group to get
+	 * @return instanceof GtkActionGroup
+	 */
+	public function get_group($group)
+	{
+		return isset($this->groups[$group]) ? $this->groups[$group] : NULL;
+	}
+
+	/**
+	 * public function get_action
+	 *
+	 * returns an action from a group (shortcut)
+	 *
+	 * @param string $group name of action group to get
+	 * @param string $action name of action to get
+	 * @return instanceof GtkAction
+	 */
+	public function get_action($group, $action)
+	{
+		return (isset($this->groups[$group]) && isset($this->groups[$group][$action])) ? $this->groups[$group][$action] : NULL;
+	}
+
+	/**
+	 * public function add_group
+	 *
+	 * adds a new group with the specific name
+	 *
+	 * @param string $group group to create
+	 * @return void
+	 */
+	public function add_group($group)
+	{
+		$this->groups[$group] = new GtkActionGroup($group);
+		unset($group);
+		return;
+	}
+
+	/**
+	 * public function add_actions
+	 *
+	 * adds actions to a specific group (shortcut)
+	 * definition is array(
+	 * 'type' => action|toggle|radio,
+	 * 'callback' => php callback,
+	 * 'accel' => accelerator string to use,
+	 * 'name' => internal name for action,
+	 * 'label' => label,
+	 * 'short-label' => shorter label (for toolbar),
+	 * 'tooltip' => tooltip for the action,
+	 * 'help-tooltip' => help tooltip for the action,
+	 * 'image' => stock id or named image),
+	 * 'value' => value for radio action,
+	 * 'radio' => for radio items, the name of the action to group with
+	 * );
+	 * 
+	 *
+	 * @param string $group group to add to
+	 * @param array $definitions array of action definitions
+	 * @return void
+	 */
+	public function add_actions($group, $definitions)
+	{
+		if(!isset($this->groups[$group]))
+		{
+			$this->add_group($group);
+		}
+		$group = $this->get_group($group);
+		foreach($definitions as $def)
+		{
+			switch($def['type'])
+			{
+				case 'radio':
+					$action = new GtkRadioAction($def['name'], Writer::i18n($def['label']), Writer::i18n($def['tooltip']),$def['image'],$def['value']);
+					$action->set_group($group->get_action($def['radio']));
+					break;
+				case 'toggle':
+					$action = new GtkToggleAction($def['name'], Writer::i18n($def['label']), Writer::i18n($def['tooltip']),$def['image']);
+					break;
+				default:
+					$action = new GtkAction($def['name'], Writer::i18n($def['label']), Writer::i18n($def['tooltip']),$def['image']);
+			}
+			$action->set_data('help-tooltip', isset($def['help-tooltip']) ? Writer::i18n($def['help-tooltip']) : NULL);
+			$action->set_property('short-label', isset($def['short-label']) ? Writer::i18n($def['short-label']) : NULL);
+			$action->connect($callback);
+			if(isset($def['accel']))
+			{
+				$action->set_accel_group($this->accel);
+				$group->add_action_with_accel($action, $def['accel']);
+			}
+			else
+			{
+				$group->add_action($action);
+			}
+		}
+		unset($def, $definitions, $group, $action, $this);
+		return;
+	}
+}
+?>
\ No newline at end of file
Property changes on: desktop/trunk/Writer/lib/actions.class.php
___________________________________________________________________
Name: tsvn:logminsize
   + 15
Name: svn:keywords
   + Id
Name: svn:eol-style
   + LF