You are here

function lightbox2_slideshow_settings_form in Lightbox2 5.2

Same name and namespace in other branches
  1. 8 lightbox2.admin.inc \lightbox2_slideshow_settings_form()
  2. 6 lightbox2.admin.inc \lightbox2_slideshow_settings_form()
  3. 7.2 lightbox2.admin.inc \lightbox2_slideshow_settings_form()
  4. 7 lightbox2.admin.inc \lightbox2_slideshow_settings_form()

Configuration form for controlling the slideshow behaviour.

1 string reference to 'lightbox2_slideshow_settings_form'
lightbox2_menu in ./lightbox2.module
Implementation of hook_menu().

File

./lightbox2.module, line 810
Enables the use of lightbox2 which places images above your current page, not within. This frees you from the constraints of the layout, particularly column widths.

Code

function lightbox2_slideshow_settings_form() {

  // Add the javascript which disables / enables form elements.
  drupal_add_js(drupal_get_path('module', 'lightbox2') . '/js/lightbox2.js', 'module');

  // Set up a hidden variable.
  $form['lightbox2_lite'] = array(
    '#type' => 'hidden',
    '#value' => variable_get('lightbox2_lite', FALSE),
  );

  // Add text box for slideshow interval.
  $form['lightbox2_slideshow_interval'] = array(
    '#type' => 'textfield',
    '#title' => t('Interval seconds'),
    '#description' => t('The slideshow interval is the length of time in seconds an image is visible before the slideshow shows the next image.'),
    '#default_value' => variable_get('lightbox2_slideshow_interval', 5),
    '#size' => 20,
  );

  // Add checkbox for slideshow automatic start.
  $form['lightbox2_slideshow_automatic_start'] = array(
    '#type' => 'checkbox',
    '#title' => t('Automatically start slideshow'),
    '#description' => t('When enabled the slideshow will automatically start.'),
    '#default_value' => variable_get('lightbox2_slideshow_automatic_start', TRUE),
  );

  // Add checkbox for slideshow automatic exit.
  $form['lightbox2_slideshow_automatic_exit'] = array(
    '#type' => 'checkbox',
    '#title' => t('Automatically exit slideshow'),
    '#description' => t('When enabled the lightbox will automatically close after displaying the last image.'),
    '#default_value' => variable_get('lightbox2_slideshow_automatic_exit', TRUE),
  );

  // Add checkbox for showing hte play / pause button.
  $form['lightbox2_slideshow_show_play_pause'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show play / pause button'),
    '#description' => t('When enabled, a play / pause button will be shown in the slideshow allowing the user more control over their viewing experience.'),
    '#default_value' => variable_get('lightbox2_slideshow_show_play_pause', TRUE),
  );

  // Add checkbox for "pausing on next click".
  $form['lightbox2_slideshow_pause_on_next_click'] = array(
    '#type' => 'checkbox',
    '#title' => t('Pause slideshow on "Next Image" click'),
    '#description' => t('When enabled the slideshow is automatically paused, and the following image shown, when the "Next" button is clicked.'),
    '#default_value' => variable_get('lightbox2_slideshow_pause_on_next_click', FALSE),
  );

  // Add checkbox for "pausing on prev click".
  $form['lightbox2_slideshow_pause_on_prev_click'] = array(
    '#type' => 'checkbox',
    '#title' => t('Pause slideshow on "Previous Image" click'),
    '#description' => t('When enabled the slideshow is automatically paused, and the previous image shown, when the "Previous" button is clicked.'),
    '#default_value' => variable_get('lightbox2_slideshow_pause_on_previous_click', TRUE),
  );

  // Add checkbox for "looping through slides'.
  $form['lightbox2_loop_slides'] = array(
    '#type' => 'checkbox',
    '#title' => t('Continuous loop'),
    '#description' => t('When enabled the slideshow will automatically start over after displaying the last slide.  This prevents the slideshow from automatically exiting when enabled.'),
    '#default_value' => variable_get('lightbox2_loop_slides', FALSE),
  );
  return system_settings_form($form);
}