-
Notifications
You must be signed in to change notification settings - Fork 1
/
views_slideshow.api.inc
202 lines (187 loc) · 5.46 KB
/
views_slideshow.api.inc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
<?php
/**
* @file
* Hooks provided by Views Slideshow.
*/
/**
* @addtogroup hooks
* @{
*/
/**
* Define the type of the slideshow (eg.: cycle, imageflow, ddblock).
*
* @return
* Associative array of slideshow type and its information.
*/
function hook_views_slideshow_slideshow_info() {
$options = array(
'views_slideshow_cycle' => array(
'name' => t('Cycle'),
'accepts' => array(
'goToSlide',
'nextSlide',
'pause',
'play',
'previousSlide',
),
'calls' => array(
'transitionBegin',
'transitionEnd',
'goToSlide',
'pause',
'play',
'nextSlide',
'previousSlide',
),
),
);
return $options;
}
/**
* Define form fields to be displayed in the views settings form.
* These fields would help configure your slideshow type.
*/
function hook_views_slideshow_slideshow_type_form(&$form, &$form_state, &$view) {
$form['views_slideshow_cycle']['effect'] = array(
'#type' => 'select',
'#title' => t('Effect'),
'#options' => $effects,
'#default_value' => $view->options['views_slideshow_cycle']['effect'],
'#description' => t('The transition effect that will be used to change between images. Not all options below may be relevant depending on the effect. ' . l('Follow this link to see examples of each effect.', 'http://jquery.malsup.com/cycle/browser.html', array('attributes' => array('target' => '_blank')))),
);
}
/**
* Define slideshow skins to be available to the end user.
*/
function hook_views_slideshow_skin_info() {
return array(
'default' => array(
'name' => t('Default'),
),
);
}
/**
* Define new widgets (pagers, controls, counters).
*
* Available events for accepts and calls
* - pause
* - play
* - nextSlide
* - previousSlide
* - goToSlide
* - transitionBegin
* - transitionEnd
*
* @return
* Array keyed by the widget names.
*/
function hook_views_slideshow_widget_info() {
return array(
'views_slideshow_pager' => array(
'name' => t('Pager'),
'accepts' => array(
'transitionBegin' => array('required' => TRUE),
'goToSlide',
'previousSlide',
'nextSlide',
),
'calls' => array(
'goToSlide',
'pause',
'play',
),
),
'views_slideshow_controls' => array(
'name' => t('Controls'),
'accepts' => array(
'pause' => array('required' => TRUE),
'play' => array('required' => TRUE),
),
'calls' => array(
'nextSlide',
'pause',
'play',
'previousSlide',
),
),
'views_slideshow_slide_counter' => array(
'name' => t('Slide Counter'),
'accepts' => array(
'transitionBegin' => array('required' => TRUE),
'goToSlide',
'previousSlide',
'nextSlide',
),
'calls' => array(),
),
);
}
/**
* Set default values for your form fields specified in hook_views_slideshow_type_form
*
* @return
* Associative array of slideshow type name and options.
*/
function hook_views_slideshow_option_definition() {
$options['views_slideshow_cycle'] = array(
'contains' => array(
// Transition
'effect' => array('default' => 'fade'),
'transition_advanced' => array('default' => 0),
'timeout' => array('default' => 5000),
'speed' => array('default' => 700), //normal
'delay' => array('default' => 0),
'sync' => array('default' => 1),
'random' => array('default' => 0),
)
);
return $options;
}
/**
* Form fields to be added for a specific widget type. Example of a widget type would be views_slideshow_pager or views_slideshow_slide_counter.
*/
function INSERT_WIDGET_TYPE_HERE_views_slideshow_widget_form_options(&$form, $form_state, $view, $defaults, $dependency) {
}
/**
* Hook called by the pager widget to configure it, the fields that should be shown.
*/
function hook_views_slideshow_widget_pager_info($view) {
}
/**
* Hook called by the pager widget to add form items.
*/
function INSERT_WIDGET_TYPE_HERE_views_slideshow_widget_pager_form_options(&$form, &$form_state, &$view, $defaults, $dependency) {
}
/**
* Hook called by the controls widget to configure it, the fields that should be shown.
*/
function hook_views_slideshow_widget_controls_info($view) {
}
/**
* Hook called by the controls widget to add form items.
*/
function INSERT_WIDGET_TYPE_HERE_views_slideshow_widget_controls_form_options(&$form, &$form_state, &$view, $defaults, $dependency) {
}
/**
* Form validation callback for the slideshow settings.
*/
function hook_views_slideshow_options_form_validate(&$form, &$form_state, &$view) {
if (!is_numeric($form_state['values']['style_options']['views_slideshow_cycle']['speed'])) {
form_error($form['views_slideshow_cycle']['speed'], t('!setting must be numeric!', array('Speed')));
}
if (!is_numeric($form_state['values']['style_options']['views_slideshow_cycle']['timeout'])) {
form_error($form['views_slideshow_cycle']['timeout'], t('!setting must be numeric!', array('timeout')));
}
if (!is_numeric($form_state['values']['style_options']['views_slideshow_cycle']['remember_slide_days'])) {
form_error($form['views_slideshow_cycle']['remember_slide_days'], t('!setting must be numeric!', array('Slide days')));
}
}
/**
* Form submission callback for the slideshow settings.
*/
function hook_views_slideshow_options_form_submit($form, &$form_state) {
// Act on option submission.
}
/**
* @} End of "addtogroup hooks".
*/