forked from appendto/jquery-vsdoc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
jquery.mobile-vsdoc.js
92 lines (90 loc) · 3.77 KB
/
jquery.mobile-vsdoc.js
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
jQuery.mobile = function(){
/// <summary>
/// The root jQuery Mobile Object.
/// </summary>
};
$.extend(jQuery.mobile, {
changePage: function( to, transition, back, changeHash ){
/// <summary>
/// Programmatically change from one page to another. This method is used internally for transitions that occur as a result of clicking a link or submitting a form, when those features are enabled.
/// Additional Signatures:
/// 	1. $.mobile.addResolutionBreakpoints( arrayOfNumbers ) - Pass an array of numbers to add min/max classes for multiple widths.
/// </summary>
/// <param name="to" type="String">
/// 	1. String - A url to transition to.
/// 2. jQuery - A jQuery object to transition to.
/// 3. Array - Array specifying two page references [from,to] for transitioning from a known page. From is otherwise assumed to be the current page in view (or $.mobile.activePage ).
/// 4. Object - Object for sending form data. ({to: url, data: serialized form data, type: 'get' or 'post'}
/// </param>
/// <param name="transition" type="String" optional="true">
/// Specifies the effect to use when switching between pages. eg. 'pop', 'slide', 'none'.
/// </param>
/// <param name="back" type="Boolean" optional="true">
/// Default value is false. True will cause a reverse-direction transition.
/// </param>
/// <param name="changeHash" type="Boolean" optional="true">
/// Default value is true. Update the hash to the to page's URL when page change is complete.
/// </param>
},
pageLoading: function( done ){
/// <summary>
/// Show or hide the page loading message, which is configurable via $.mobile.loadingMessage.
/// </summary>
/// <param name="done" type="Boolean">
/// Defaults value is false, indicating loading has started. A value of true will hide the loading message.
/// </param>
},
silentScroll: function( yPos ){
/// <summary>
/// Scroll to a particular Y position without triggering scroll event listeners.
/// </summary>
/// <param name="yPos" type="Number" integer="true">
/// Specifies a y-axis position that the page should scroll to.
/// </param>
},
addResolutionBreakpoints: function( width ){
/// <summary>
/// Add width breakpoints to the min/max width classes that are added to the HTML element.
/// Additional Signatures:
/// 	1. $.mobile.addResolutionBreakpoints( arrayOfNumbers ) - Pass an array of numbers to add min/max classes for multiple widths.
/// </summary>
/// <param name="width" type="Number" integer="true">
/// A number or array of numbers to add to the resolution classes.
/// </param>
},
activePage: function(){
/// <summary>
/// Returns a reference to the page currently in view.
/// </summary>
/// <param name="property" type="Object">
/// Unknown.
/// </param>
/// <returns type="Object" />
},
media: function( query ){
/// <summary>
/// A function that allows you to test whether a particular CSS Media Query applies.
/// </summary>
/// <param name="selector" type="String">
/// A string specifyin the query or css type to be queried.
/// //test for screen media type
/// $.mobile.media("screen");
/// //test a min-width media query
/// $.mobile.media("screen and (min-width: 480px)");
/// //test for iOS retina display
/// $.mobile.media("screen and (-webkit-min-device-pixel-ratio: 2)");
/// </param>
/// <returns type="Boolean">
/// If the browser supports the type or query specified, and it currently applies, the function will return true. If not, it'll return false.
/// </returns>
}
});
/// <summary>
///
/// </summary>
/// <param name="selector" type="String">
///
/// </param>
/// <returns type="Boolean">
///
/// </returns>