class sweaver_plugin_kb in Sweaver 7

@file Key bindings plugin.

Hierarchy

• class \sweaver_plugin
  • class \sweaver_plugin_kb

1 string reference to 'sweaver_plugin_kb'

_sweaver_sweaver_plugins in ./sweaver.registry.inc

Sweaver plugins.

File

plugins/sweaver_plugin_kb/sweaver_plugin_kb.inc, line 7

Key bindings plugin.

class sweaver_plugin_kb extends sweaver_plugin {

  /**
   * Sweaver dependencies.
   */
  public function sweaver_dependencies() {
    if (!variable_get('sweaver_plugin_status_sweaver_plugin_styles', FALSE)) {
      return array(
        'Manage styles',
      );
    }
    return array();
  }

  /**
   * Menu registry.
   */
  public function sweaver_menu(&$weight, $page_arguments, $base) {
    $items = array();
    $items['admin/config/user-interface/sweaver/kb'] = $base + array(
      'title' => 'Keyboard',
      'page arguments' => array(
        $page_arguments,
      ),
      'type' => MENU_LOCAL_TASK,
      'weight' => $weight++,
    );
    return $items;
  }

  /**
   * Frontend css and js.
   */
  public function sweaver_form_css_js(&$inline_settings) {
    drupal_add_js(drupal_get_path('module', 'sweaver') . '/plugins/sweaver_plugin_kb/jquery.hotkeys.js');
    drupal_add_js(drupal_get_path('module', 'sweaver') . '/plugins/sweaver_plugin_kb/sweaver_plugin_kb.js');
    $bindings = $this
      ->sweaver_kb_bindings();
    $binding_options = $this
      ->sweaver_kb_binding_options();
    foreach ($bindings as $key => $value) {

      // Do not add when a certain variable isn't set. (eg delete tab)
      if (isset($value['variable']) && !variable_get($value['variable'], FALSE)) {
        continue;
      }

      // Get keyboard key. Make sure it's not empty.
      $keyboard_key = variable_get('sweaver_plugin_kb_' . $key, $value['default']);
      if (!empty($keyboard_key)) {
        $inline_settings['sweaver']['kb'][$key] = array(
          'kb_code' => $keyboard_key,
          'kb_button' => $binding_options[$keyboard_key],
          'element' => isset($value['element']) ? $value['element'] : '',
          'page_callback' => isset($value['page_callback']) ? $value['page_callback'] : '',
          'message' => isset($value['message']) ? $value['message'] : '',
        );
      }
    }
  }

  /**
   * Keyboard bindings settings form.
   */
  public function sweaver_menu_callback() {
    $form = array();
    $bindings = $this
      ->sweaver_kb_bindings();
    $binding_options = $this
      ->sweaver_kb_binding_options();
    $form['info'] = array(
      '#markup' => t('Select keys for every event possible. Note, there is no validation when saving this form, so make sure every event has a unique key.'),
    );
    foreach ($bindings as $key => $value) {
      $form['sweaver_plugin_kb_' . $key] = array(
        '#type' => 'select',
        '#options' => $binding_options,
        '#title' => $value['title'],
        '#default_value' => variable_get('sweaver_plugin_kb_' . $key, $value['default']),
      );
    }
    return system_settings_form($form);
  }

  /**
   * Possible keyboard bindings.
   */
  public function sweaver_kb_bindings() {
    $bindings = array(
      'save' => array(
        'title' => t('Save style popup'),
        'default' => '83',
        'element' => '.save-style-popup',
        'double' => TRUE,
      ),
      'load' => array(
        'title' => t('Load style popup'),
        'default' => '76',
        'element' => '.load-style-popup',
        'double' => TRUE,
      ),
      'publish' => array(
        'title' => t('Publish style popup'),
        'default' => '80',
        'element' => '.publish-style-popup',
        'double' => TRUE,
      ),
      'delete' => array(
        'title' => t('Delete style popup'),
        'default' => '68',
        'variable' => 'sweaver_styles_delete_tab',
        'element' => '.delete-style-popup',
        'double' => TRUE,
      ),
      'close' => array(
        'title' => t('Close popup'),
        'default' => '27',
        'double' => FALSE,
      ),
      'undo' => array(
        'title' => t('Undo modification'),
        'default' => '65',
        'double' => FALSE,
        'page_callback' => 'Drupal.Sweaver.undoModification',
        'message' => t('Modification undone'),
      ),
      'redo' => array(
        'title' => t('Redo modification'),
        'default' => '90',
        'double' => FALSE,
        'page_callback' => 'Drupal.Sweaver.redoModification',
        'message' => t('Modification redone'),
      ),
    );
    return $bindings;
  }

  /**
   * All possible keyboard bindings.
   */
  public function sweaver_kb_binding_options() {
    return array(
      '',
      '27' => 'esc',
      '48' => '0',
      '49' => '1',
      '50' => '2',
      '51' => '3',
      '52' => '4',
      '53' => '5',
      '54' => '6',
      '55' => '7',
      '56' => '8',
      '57' => '9',
      '65' => 'a',
      '66' => 'b',
      '67' => 'c',
      '68' => 'd',
      '69' => 'e',
      '70' => 'f',
      '71' => 'g',
      '72' => 'h',
      '73' => 'i',
      '74' => 'j',
      '75' => 'k',
      '76' => 'l',
      '77' => 'm',
      '78' => 'n',
      '79' => 'o',
      '80' => 'p',
      '81' => 'q',
      '82' => 'r',
      '83' => 's',
      '84' => 't',
      '85' => 'u',
      '86' => 'v',
      '87' => 'w',
      '88' => 'x',
      '89' => 'y',
      '90' => 'z',
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
sweaver_plugin::show_editor	public	function	Return false to not show editor.	1
sweaver_plugin::sweaver_form	public	function	Sweaver form.	8
sweaver_plugin::sweaver_form_render	public	function	Sweaver form render.	3
sweaver_plugin::sweaver_form_submit	public	function	Sweaver submit handler.	6
sweaver_plugin::sweaver_images_handler	public	function	Images handler.	1
sweaver_plugin::sweaver_init	public	function	Init function.	1
sweaver_plugin::sweaver_menu_access_callback	public	function	Return true to allow access and false to deny.	1
sweaver_plugin::sweaver_menu_callback_submit	public	function	Menu callback submit.	2
sweaver_plugin::sweaver_menu_callback_validate	public	function	Menu callback validate.
sweaver_plugin::sweaver_objects_alter	public	function	Sweaver objects alter.	1
sweaver_plugin::sweaver_popups_render	protected	function	Helper function render the popups.
sweaver_plugin::sweaver_preprocess_page	public	function	Preprocess page function.	1
sweaver_plugin::sweaver_theme	public	function	Theme registry.	1
sweaver_plugin_kb::sweaver_dependencies	public	function	Sweaver dependencies. Overrides sweaver_plugin::sweaver_dependencies
sweaver_plugin_kb::sweaver_form_css_js	public	function	Frontend css and js. Overrides sweaver_plugin::sweaver_form_css_js
sweaver_plugin_kb::sweaver_kb_bindings	public	function	Possible keyboard bindings.
sweaver_plugin_kb::sweaver_kb_binding_options	public	function	All possible keyboard bindings.
sweaver_plugin_kb::sweaver_menu	public	function	Menu registry. Overrides sweaver_plugin::sweaver_menu
sweaver_plugin_kb::sweaver_menu_callback	public	function	Keyboard bindings settings form. Overrides sweaver_plugin::sweaver_menu_callback