function _menu_minipanels_hover_settings_form in Menu Minipanels 7

Same name and namespace in other branches

1. 6 menu_minipanels.admin.inc \_menu_minipanels_hover_settings_form()

The configuration form for the qtip. This form simply mirrors the options specified at: http://craigsworks.com/projects/qtip/docs/reference/

2 calls to _menu_minipanels_hover_settings_form()

menu_minipanels_admin in ./menu_minipanels.admin.inc

Page callback for admin/settings/menu_minipanels

menu_minipanels_form_menu_edit_item_alter in ./menu_minipanels.module

Implements hook_form_FORM_ID_alter().

File

./menu_minipanels.admin.inc, line 80

Code

function _menu_minipanels_hover_settings_form(&$base_form, $settings) {
  $original_defaults = _menu_minipanels_hover_defaults();
  $defaults = variable_get('menu_minipanels_hover', array());
  $defaults = array_replace_recursive($original_defaults, $defaults);

  // Setting up select lists used in the config form
  // Used for both show and hide effect options.
  $effect_options = array(
    'false' => t('None'),
    'fade' => t('Fade'),
    'slide' => t('Slide'),
    'grow' => t('Grow'),
  );

  // Used in many places.
  $boolean_options = array(
    'true' => t('True'),
    'false' => t('False'),
  );

  // Used in many places.
  $options_tips = array(
    'topLeft' => t('Top left'),
    'topMiddle' => t('Top middle'),
    'topRight' => t('Top right'),
    'rightTop' => t('Right top'),
    'rightMiddle' => t('Right middle'),
    'rightBottom' => t('Right bottom'),
    'bottomRight' => t('Bottom right'),
    'bottomMiddle' => t('Bottom middle'),
    'bottomLeft' => t('Bottom left'),
    'leftBottom' => t('Left bottom'),
    'leftMiddle' => t('Left middle'),
    'leftTop' => t('Left top'),
  );

  // Make this a #tree structure, so that form data collapses nicely into an
  // associate array so that we can simply print it out as javascript and it
  // fits the data structure that qtip is expecting.  Also, add a surrounding
  // div that our javascript code can use to hide/show the qtip configuration
  // when a minipanel is selected.
  $base_form['menu_minipanels_hover'] = array(
    '#tree' => TRUE,
    '#prefix' => '<div id="menu-minipanels-hover-settings">',
    '#suffix' => '</div>',
  );

  // This section - tooltip position.
  $base_form['menu_minipanels_hover']['position'] = array(
    '#type' => 'fieldset',
    '#title' => t('Hover position configuration'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $target_options = array(
    'false' => t('Menu item'),
    'mouse' => t('Current mouse position'),
    'custom' => t('Custom (see below)'),
  );
  $base_form['menu_minipanels_hover']['position']['target'] = array(
    '#type' => 'select',
    '#title' => t('Target'),
    '#description' => t('The location the menu will appear relative to. If "custom" is selected a field will appear in order to provide a jQuery selector.'),
    '#default_value' => isset($settings['position']['target']) ? $settings['position']['target'] : $defaults['position']['target'],
    '#options' => $target_options,
    '#required' => TRUE,
  );
  $base_form['menu_minipanels_hover']['position']['target_custom'] = array(
    '#type' => 'textfield',
    '#title' => t('Custom target'),
    '#description' => t('If \'custom\' is selected above, specify a jQuery selector, e.g. \'#header\' (without the quotes).'),
    '#default_value' => isset($settings['position']['target_custom']) ? $settings['position']['target_custom'] : $defaults['position']['target_custom'],
    '#required' => FALSE,
    '#dependency' => array(
      'edit-menu-minipanels-hover-position-target' => array(
        'custom',
      ),
    ),
  );
  $type_options = array(
    'absolute' => t('Absolute'),
    'fixed' => t('Fixed'),
    'relative' => t('Relative'),
    'static' => t('Static'),
  );
  $base_form['menu_minipanels_hover']['position']['type'] = array(
    '#type' => 'select',
    '#title' => t('Position type'),
    '#description' => t('Choose how the popup is positioned.'),
    '#default_value' => isset($settings['position']['type']) ? $settings['position']['type'] : $defaults['position']['type'],
    '#options' => $type_options,
    '#required' => TRUE,
  );
  $base_form['menu_minipanels_hover']['position']['container'] = array(
    '#type' => 'textfield',
    '#title' => t('Container'),
    '#description' => t('Allows control over where within the page\'s DOM structure the minipanel will be inserted. This defaults to $(document.body), i.e. at the end of the page\'s content.'),
    '#default_value' => isset($settings['position']['container']) ? $settings['position']['container'] : $defaults['position']['container'],
    '#required' => FALSE,
  );
  $base_form['menu_minipanels_hover']['position']['corner'] = array();
  $base_form['menu_minipanels_hover']['position']['corner']['target'] = array(
    '#type' => 'select',
    '#title' => t('Target'),
    '#description' => t('Choose the tooltip target.'),
    '#default_value' => isset($settings['position']['corner']['target']) ? $settings['position']['corner']['target'] : $defaults['position']['corner']['target'],
    '#options' => $options_tips,
    '#required' => TRUE,
  );
  $base_form['menu_minipanels_hover']['position']['corner']['tooltip'] = array(
    '#type' => 'select',
    '#title' => t('Tooltip'),
    '#description' => t('Choose the tooltip position.'),
    '#default_value' => isset($settings['position']['corner']['tooltip']) ? $settings['position']['corner']['tooltip'] : $defaults['position']['corner']['tooltip'],
    '#options' => $options_tips,
    '#required' => TRUE,
  );
  $base_form['menu_minipanels_hover']['position']['adjust'] = array();
  $base_form['menu_minipanels_hover']['position']['adjust']['x'] = array(
    '#type' => 'textfield',
    '#title' => t('Horizontal adjustment (px)'),
    '#description' => t('Increment by which to increase the x value of the tooltip coordinate, in pixels. To decrease, use a minus number. Both the Horizontal and Vertical values are required, and neither may be "0", if they are to be used.'),
    '#default_value' => isset($settings['position']['adjust']['x']) ? $settings['position']['adjust']['x'] : $defaults['position']['adjust']['x'],
    '#required' => TRUE,
  );
  $base_form['menu_minipanels_hover']['position']['adjust']['y'] = array(
    '#type' => 'textfield',
    '#title' => t('Vertical adjustment (px)'),
    '#description' => t('Increment by which to increase the y value of the tooltip coordinate, in pixels. To decrease, use a minus number. Both the Horizontal and Vertical values are required, and neither may be "0", if they are to be used.'),
    '#default_value' => isset($settings['position']['adjust']['y']) ? $settings['position']['adjust']['y'] : $defaults['position']['adjust']['y'],
    '#required' => TRUE,
  );

  // This section - showing the tooltip.
  $base_form['menu_minipanels_hover']['show'] = array(
    '#type' => 'fieldset',
    '#title' => t('Show effect configuration'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $base_form['menu_minipanels_hover']['show']['delay'] = array(
    '#type' => 'textfield',
    '#title' => t('Delay (milliseconds)'),
    '#description' => t('How long the tooltip should wait before showing.'),
    '#default_value' => isset($settings['show']['delay']) ? $settings['show']['delay'] : $defaults['show']['delay'],
    '#required' => TRUE,
  );
  $when_options = array(
    'click' => t('Click'),
    'dblclick' => t('Double click'),
    'mouseover' => t('Mouse over'),
    'mouseenter' => t('Mouse enter'),
  );
  $base_form['menu_minipanels_hover']['show']['when'] = array();
  $base_form['menu_minipanels_hover']['show']['when']['event'] = array(
    '#type' => 'select',
    '#title' => t('Show Event'),
    '#description' => t('When the menu should appear.'),
    '#default_value' => isset($settings['show']['when']['event']) ? $settings['show']['when']['event'] : $defaults['show']['when']['event'],
    '#options' => $when_options,
    '#required' => TRUE,
  );
  $base_form['menu_minipanels_hover']['show']['effect'] = array();
  $base_form['menu_minipanels_hover']['show']['effect']['type'] = array(
    '#type' => 'select',
    '#title' => t('Effect'),
    '#description' => t('The animation effect that will be used to hide the popup.'),
    '#default_value' => isset($settings['show']['effect']['type']) ? $settings['show']['effect']['type'] : $defaults['show']['effect']['type'],
    '#options' => $effect_options,
    '#required' => TRUE,
  );
  $base_form['menu_minipanels_hover']['show']['effect']['length'] = array(
    '#type' => 'textfield',
    '#title' => t('Length of effect (milliseconds)'),
    '#description' => t('How long the effect will take to complete.'),
    '#default_value' => isset($settings['show']['effect']['length']) ? $settings['show']['effect']['length'] : $defaults['show']['effect']['length'],
    '#required' => TRUE,
  );

  // This section - hiding the tooltip.
  $base_form['menu_minipanels_hover']['hide'] = array(
    '#type' => 'fieldset',
    '#title' => t('Hide effect configuration'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $base_form['menu_minipanels_hover']['hide']['delay'] = array(
    '#type' => 'textfield',
    '#title' => t('Delay (milliseconds)'),
    '#description' => t('How long the tooltip should wait before hiding.'),
    '#default_value' => isset($settings['hide']['delay']) ? $settings['hide']['delay'] : $defaults['hide']['delay'],
    '#required' => TRUE,
  );
  $base_form['menu_minipanels_hover']['hide']['effect'] = array();
  $base_form['menu_minipanels_hover']['hide']['effect']['type'] = array(
    '#type' => 'select',
    '#title' => t('Effect Type'),
    '#description' => t('Choose an effect.'),
    '#default_value' => isset($settings['hide']['effect']['type']) ? $settings['hide']['effect']['type'] : $defaults['hide']['effect']['type'],
    '#options' => $effect_options,
    '#required' => TRUE,
  );
  $base_form['menu_minipanels_hover']['hide']['effect']['length'] = array(
    '#type' => 'textfield',
    '#title' => t('Length of effect (milliseconds)'),
    '#description' => t('How long the effect will take to complete.'),
    '#default_value' => isset($settings['hide']['effect']['length']) ? $settings['hide']['effect']['length'] : $defaults['hide']['effect']['length'],
    '#required' => TRUE,
  );

  // This section - style configuration.
  $base_form['menu_minipanels_hover']['style'] = array(
    '#type' => 'fieldset',
    '#title' => t('Style configuration'),
    '#description' => t('Leave these values blank (except for <em>Arrow position</em>) to inherit the style\'s default value.'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $base_form['menu_minipanels_hover']['style']['tip'] = array(
    '#type' => 'select',
    '#title' => t('Arrow position'),
    '#description' => t('Choose the location of the arrow tip on the popup box.'),
    '#default_value' => isset($settings['style']['tip']) ? $settings['style']['tip'] : $defaults['style']['tip'],
    '#options' => array_merge(array(
      'none' => 'None',
    ), $options_tips),
    '#required' => TRUE,
  );
  $base_form['menu_minipanels_hover']['style']['name'] = array(
    '#type' => 'select',
    '#title' => t('Style name'),
    '#description' => t('The name of the style to apply.'),
    '#default_value' => isset($settings['style']['name']) ? $settings['style']['name'] : $defaults['style']['name'],
    '#options' => _menu_minipanels_get_styles(),
    '#required' => TRUE,
    '#description' => t('Custom styles can be created, see the API.txt file for further details.'),
  );
  $base_form['menu_minipanels_hover']['style']['width'] = array();
  $base_form['menu_minipanels_hover']['style']['width']['min'] = array(
    '#type' => 'textfield',
    '#title' => t('Minimum popup width (px)'),
    '#description' => t('The popup will automatically scale to match the size required for its contents. This sets a minimum width, in pixels, that it is allowed to expand to.'),
    '#default_value' => isset($settings['style']['width']['min']) ? $settings['style']['width']['min'] : $defaults['style']['width']['min'],
    '#required' => FALSE,
  );
  $base_form['menu_minipanels_hover']['style']['width']['max'] = array(
    '#type' => 'textfield',
    '#title' => t('Maximum popup width (px)'),
    '#description' => t('The popup will automatically scale to match the size required for its contents. This sets a maximum width, in pixels, that it is allowed to expand to.'),
    '#default_value' => isset($settings['style']['width']['max']) ? $settings['style']['width']['max'] : $defaults['style']['width']['max'],
    '#required' => FALSE,
  );
  $base_form['menu_minipanels_hover']['style']['border'] = array();
  $base_form['menu_minipanels_hover']['style']['border']['width'] = array(
    '#type' => 'textfield',
    '#title' => t('Border width (px)'),
    '#description' => t('Width of the border in pixels (excl. px).'),
    '#default_value' => isset($settings['style']['border']['width']) ? $settings['style']['border']['width'] : $defaults['style']['border']['width'],
    '#required' => FALSE,
  );
  $base_form['menu_minipanels_hover']['style']['border']['color'] = array(
    '#type' => 'textfield',
    '#title' => t('Border color'),
    '#description' => t('Color of the border, including the "#" symbol.'),
    '#default_value' => isset($settings['style']['border']['color']) ? $settings['style']['border']['color'] : $defaults['style']['border']['color'],
    '#required' => FALSE,
  );
  $base_form['menu_minipanels_hover']['style']['border']['radius'] = array(
    '#type' => 'textfield',
    '#title' => t('Border radius (px)'),
    '#description' => t('Determines the roundness of the tooltip border.'),
    '#default_value' => isset($settings['style']['border']['radius']) ? $settings['style']['border']['radius'] : $defaults['style']['border']['radius'],
    '#required' => FALSE,
  );
  return $base_form;
}