diff --git a/doc/API-html/ITEAD-logo.JPG b/doc/API-html/ITEAD-logo.JPG new file mode 100644 index 00000000..b13d5c0 Binary files /dev/null and b/doc/API-html/ITEAD-logo.JPG differ diff --git a/doc/API-html/_comp_button_8ino_source.html b/doc/API-html/_comp_button_8ino_source.html new file mode 100644 index 00000000..759ec13 --- /dev/null +++ b/doc/API-html/_comp_button_8ino_source.html @@ -0,0 +1,119 @@ + + + + + + +API: examples/CompButton/CompButton.ino Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + + +
+
+
+
CompButton.ino
+
+
+
1 
+
16 #include "NexButton.h"
+
17 
+
18 NexButton b0 = NexButton(0, 1, "b0");
+
19 char buffer[100] = {0};
+
20 
+
21 NexTouch *nexListenList[] =
+
22 {
+
23  &b0,
+
24  NULL
+
25 };
+
26 
+
27 void b0PopCallback(void *ptr)
+
28 {
+
29  uint16_t len;
+
30  uint16_t number;
+
31  NexButton *btn = (NexButton *)ptr;
+
32 
+
33  dbSerial.println("b0PopCallback");
+
34  dbSerial.print("ptr=");
+
35  dbSerial.println((uint32_t)ptr);
+
36 
+
37  memset(buffer, 0, sizeof(buffer));
+
38  btn->getText(buffer, sizeof(buffer));
+
39 
+
40  number = atoi(buffer);
+
41  number += 1;
+
42 
+
43  memset(buffer, 0, sizeof(buffer));
+
44  itoa(number, buffer, 10);
+
45 
+
46  btn->setText(buffer);
+
47 }
+
48 
+
49 void setup(void)
+
50 {
+
51  dbSerial.begin(9600);
+
52  nexInit();
+
53  b0.attachPop(b0PopCallback, &b0);
+
54  dbSerial.println("setup done");
+
55 }
+
56 
+
57 void loop(void)
+
58 {
+
59  dbSerial.println("nexLoop");
+
60  nexLoop(nexListenList);
+
61 }
+
uint16_t getText(char *buffer, uint16_t len)
Get text value from button component.
Definition: NexButton.cpp:35
+
bool nexInit(void)
Init Nextion's baudrate,page id.
Definition: NexTouch.cpp:423
+
API of NexButton.
+
bool nexLoop(NexTouch **nexListenList)
Call mainEventLoop,watting for Nextion's touch event.
Definition: NexTouch.cpp:440
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register button pop callback function.
Definition: NexButton.cpp:70
+
NexButton,subclass of NexTouch,provides simple methods to control button component.
Definition: NexButton.h:25
+
bool setText(const char *buffer)
Set text value of button component.
Definition: NexButton.cpp:53
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/_comp_hotspot_8ino-example.html b/doc/API-html/_comp_hotspot_8ino-example.html new file mode 100644 index 00000000..4206eb8 --- /dev/null +++ b/doc/API-html/_comp_hotspot_8ino-example.html @@ -0,0 +1,116 @@ + + + + + + +API: CompHotspot.ino + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + +
+
+
+
CompHotspot.ino
+
+
+
Show how to use API of class NexHotspot.
+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ +
+
#include "NexHotspot.h"
+
+
NexHotspot hot0 = NexHotspot(0, 1, "hot0");
+
NexHotspot hot1 = NexHotspot(0, 2, "hot1");
+
+
NexTouch *nexListenList[] =
+
{
+
&hot0,
+
&hot1,
+
NULL
+
};
+
+
void hot0PushCallback(void *ptr)
+
{
+
dbSerial.println("hot0PushCallback");
+
dbSerial.print("ptr=");
+
dbSerial.println((uint32_t)ptr);
+
}
+
+
void hot1PushCallback(void *ptr)
+
{
+
dbSerial.println("hot1PushCallback");
+
dbSerial.print("ptr=");
+
dbSerial.println((uint32_t)ptr);
+
}
+
+
void hot0PopCallback(void *ptr)
+
{
+
dbSerial.println("hot0PopCallback");
+
dbSerial.print("ptr=");
+
dbSerial.println((uint32_t)ptr);
+
}
+
+
void hot1PopCallback(void *ptr)
+
{
+
dbSerial.println("hot1PopCallback");
+
dbSerial.print("ptr=");
+
dbSerial.println((uint32_t)ptr);
+
}
+
+
void setup(void)
+
{
+
dbSerial.begin(9600);
+ +
hot0.attachPush(hot0PushCallback, &hot0);
+
hot0.attachPop(hot0PopCallback, &hot0);
+
hot1.attachPush(hot1PushCallback, &hot1);
+
hot1.attachPop(hot1PopCallback, &hot1);
+
dbSerial.println("setup done");
+
}
+
+
void loop(void)
+
{
+
dbSerial.println("nexLoop");
+
nexLoop(nexListenList);
+
}
+
+ + + + diff --git a/doc/API-html/_comp_hotspot_8ino_source.html b/doc/API-html/_comp_hotspot_8ino_source.html new file mode 100644 index 00000000..3f9d284 --- /dev/null +++ b/doc/API-html/_comp_hotspot_8ino_source.html @@ -0,0 +1,128 @@ + + + + + + +API: examples/CompHotspot/CompHotspot.ino Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + + +
+
+
+
CompHotspot.ino
+
+
+
1 
+
16 #include "NexHotspot.h"
+
17 
+
18 NexHotspot hot0 = NexHotspot(0, 1, "hot0");
+
19 NexHotspot hot1 = NexHotspot(0, 2, "hot1");
+
20 
+
21 NexTouch *nexListenList[] =
+
22 {
+
23  &hot0,
+
24  &hot1,
+
25  NULL
+
26 };
+
27 
+
28 void hot0PushCallback(void *ptr)
+
29 {
+
30  dbSerial.println("hot0PushCallback");
+
31  dbSerial.print("ptr=");
+
32  dbSerial.println((uint32_t)ptr);
+
33 }
+
34 
+
35 void hot1PushCallback(void *ptr)
+
36 {
+
37  dbSerial.println("hot1PushCallback");
+
38  dbSerial.print("ptr=");
+
39  dbSerial.println((uint32_t)ptr);
+
40 }
+
41 
+
42 void hot0PopCallback(void *ptr)
+
43 {
+
44  dbSerial.println("hot0PopCallback");
+
45  dbSerial.print("ptr=");
+
46  dbSerial.println((uint32_t)ptr);
+
47 }
+
48 
+
49 void hot1PopCallback(void *ptr)
+
50 {
+
51  dbSerial.println("hot1PopCallback");
+
52  dbSerial.print("ptr=");
+
53  dbSerial.println((uint32_t)ptr);
+
54 }
+
55 
+
56 void setup(void)
+
57 {
+
58  dbSerial.begin(9600);
+
59  nexInit();
+
60  hot0.attachPush(hot0PushCallback, &hot0);
+
61  hot0.attachPop(hot0PopCallback, &hot0);
+
62  hot1.attachPush(hot1PushCallback, &hot1);
+
63  hot1.attachPop(hot1PopCallback, &hot1);
+
64  dbSerial.println("setup done");
+
65 }
+
66 
+
67 void loop(void)
+
68 {
+
69  dbSerial.println("nexLoop");
+
70  nexLoop(nexListenList);
+
71 }
+
bool nexInit(void)
Init Nextion's baudrate,page id.
Definition: NexTouch.cpp:423
+
bool nexLoop(NexTouch **nexListenList)
Call mainEventLoop,watting for Nextion's touch event.
Definition: NexTouch.cpp:440
+
API of NexHotspot.
+
NexHotspot,subclass of NexTouch,provides simple methods to control hotspot component.
Definition: NexHotspot.h:25
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register hotspot pop callback function.
Definition: NexHotspot.cpp:55
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
void attachPush(NexTouchEventCb push, void *ptr=NULL)
Register hotspot push callback function.
Definition: NexHotspot.cpp:35
+
+ + + + diff --git a/doc/API-html/_comp_page_8ino_source.html b/doc/API-html/_comp_page_8ino_source.html new file mode 100644 index 00000000..8db6427 --- /dev/null +++ b/doc/API-html/_comp_page_8ino_source.html @@ -0,0 +1,131 @@ + + + + + + +API: examples/CompPage/CompPage.ino Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + + +
+
+
+
CompPage.ino
+
+
+
1 
+
16 #include "NexPage.h"
+
17 
+
18 NexPage page0 = NexPage(0, 0, "page0");
+
19 NexPage page1 = NexPage(1, 0, "page1");
+
20 NexPage page2 = NexPage(2, 0, "page2");
+
21 NexPage page3 = NexPage(3, 0, "page3");
+
22 
+
23 NexTouch *nexListenList[] =
+
24 {
+
25  &page0,
+
26  &page1,
+
27  &page2,
+
28  &page3,
+
29  NULL
+
30 };
+
31 
+
32 void page0PopCallback(void *ptr)
+
33 {
+
34  dbSerial.println("page0PopCallback");
+
35  page1.show();
+
36 }
+
37 
+
38 void page1PopCallback(void *ptr)
+
39 {
+
40  dbSerial.println("page1PopCallback");
+
41  page2.show();
+
42 }
+
43 
+
44 void page2PopCallback(void *ptr)
+
45 {
+
46  dbSerial.println("page2PopCallback");
+
47  page3.show();
+
48 }
+
49 
+
50 void page3PopCallback(void *ptr)
+
51 {
+
52  dbSerial.println("page3PopCallback");
+
53  page0.show();
+
54 }
+
55 
+
56 void setup(void)
+
57 {
+
58  dbSerial.begin(9600);
+
59  nexInit();
+
60  dbSerial.println("setup begin");
+
61 
+
62  page0.attachPop(page0PopCallback);
+
63  page1.attachPop(page1PopCallback);
+
64  page2.attachPop(page2PopCallback);
+
65  page3.attachPop(page3PopCallback);
+
66 
+
67  dbSerial.println("setup end");
+
68 }
+
69 
+
70 void loop(void)
+
71 {
+
72  dbSerial.println("nexLoop");
+
73  nexLoop(nexListenList);
+
74 }
+
bool show(void)
Change page.
Definition: NexPage.cpp:33
+
bool nexInit(void)
Init Nextion's baudrate,page id.
Definition: NexTouch.cpp:423
+
bool nexLoop(NexTouch **nexListenList)
Call mainEventLoop,watting for Nextion's touch event.
Definition: NexTouch.cpp:440
+
API of NexPage.
+
NexPage,subclass of NexTouch,provides simple methods to control page component.
Definition: NexPage.h:25
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register page pop callback function.
Definition: NexPage.cpp:55
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/_comp_picture_8ino_source.html b/doc/API-html/_comp_picture_8ino_source.html new file mode 100644 index 00000000..278cf0c --- /dev/null +++ b/doc/API-html/_comp_picture_8ino_source.html @@ -0,0 +1,117 @@ + + + + + + +API: examples/CompPicture/CompPicture.ino Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + + +
+
+
+
CompPicture.ino
+
+
+
1 
+
16 #include "NexPicture.h"
+
17 
+
18 NexPicture p0 = NexPicture(0, 1, "p0");
+
19 
+
20 NexTouch *nexListenList[] =
+
21 {
+
22  &p0,
+
23  NULL
+
24 };
+
25 
+
26 void p0PopCallback(void *ptr)
+
27 {
+
28  uint32_t number = 0;
+
29  dbSerial.println("p0PopCallback");
+
30 
+
31  p0.getPic(&number);
+
32 
+
33  if (number == 1)
+
34  {
+
35  number = 2;
+
36  }
+
37  else
+
38  {
+
39  number = 1;
+
40  }
+
41 
+
42  p0.setPic(number);
+
43 }
+
44 
+
45 
+
46 void setup(void)
+
47 {
+
48  dbSerial.begin(9600);
+
49  nexInit();
+
50  p0.attachPop(p0PopCallback);
+
51  dbSerial.println("setup done");
+
52 }
+
53 
+
54 void loop(void)
+
55 {
+
56  dbSerial.println("nexLoop");
+
57  nexLoop(nexListenList);
+
58 }
+
59 
+
bool nexInit(void)
Init Nextion's baudrate,page id.
Definition: NexTouch.cpp:423
+
bool setPic(uint32_t number)
Set picture's number.
Definition: NexPicture.cpp:52
+
bool nexLoop(NexTouch **nexListenList)
Call mainEventLoop,watting for Nextion's touch event.
Definition: NexTouch.cpp:440
+
NexPicture,subclass of NexTouch,provides simple methods to control picture component.
Definition: NexPicture.h:25
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register picture pop callback function.
Definition: NexPicture.cpp:72
+
bool getPic(uint32_t *number)
Get picture's number.
Definition: NexPicture.cpp:35
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
API of NexPicture.
+
+ + + + diff --git a/doc/API-html/_comp_pointer_8ino_source.html b/doc/API-html/_comp_pointer_8ino_source.html new file mode 100644 index 00000000..ae2a552 --- /dev/null +++ b/doc/API-html/_comp_pointer_8ino_source.html @@ -0,0 +1,135 @@ + + + + + + +API: examples/CompPointer/CompPointer.ino Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + + +
+
+
+
CompPointer.ino
+
+
+
1 
+
16 #include "NexPointer.h"
+
17 #include "NexButton.h"
+
18 
+
19 NexPointer pointer = NexPointer(0, 1, "pointer");
+
20 NexButton btn_up = NexButton(0, 2, "btn_up");
+
21 NexButton btn_down = NexButton(0, 3, "btn_down");
+
22 
+
23 NexTouch *nexListenList[] =
+
24 {
+
25  &btn_up,
+
26  &btn_down,
+
27  NULL
+
28 };
+
29 
+
30 void buttonUpPopCallback(void *ptr)
+
31 {
+
32  uint32_t number = 0;
+
33  dbSerial.println("buttonUpPopCallback");
+
34 
+
35  pointer.getValue(&number);
+
36 
+
37  number += 5;
+
38  if (number >= 360)
+
39  {
+
40  number = 0;
+
41  }
+
42 
+
43  pointer.setValue(number);
+
44 }
+
45 void buttonDownPopCallback(void *ptr)
+
46 {
+
47  uint32_t number = 0;
+
48  dbSerial.println("buttonDownPopCallback");
+
49 
+
50  pointer.getValue(&number);
+
51 
+
52  if (number >= 5)
+
53  {
+
54  number -= 5;
+
55  }
+
56 
+
57  pointer.setValue(number);
+
58 }
+
59 
+
60 
+
61 
+
62 void setup(void)
+
63 {
+
64  dbSerial.begin(9600);
+
65  nexInit();
+
66  btn_up.attachPop(buttonUpPopCallback);
+
67  btn_down.attachPop(buttonDownPopCallback);
+
68  dbSerial.println("setup done");
+
69 }
+
70 
+
71 void loop(void)
+
72 {
+
73  dbSerial.println("nexLoop");
+
74  nexLoop(nexListenList);
+
75 }
+
76 
+
bool nexInit(void)
Init Nextion's baudrate,page id.
Definition: NexTouch.cpp:423
+
API of NexButton.
+
bool nexLoop(NexTouch **nexListenList)
Call mainEventLoop,watting for Nextion's touch event.
Definition: NexTouch.cpp:440
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register button pop callback function.
Definition: NexButton.cpp:70
+
bool getValue(uint32_t *number)
Get the value of pointer.
Definition: NexPointer.cpp:20
+
NexPointer,subclass of NexTouch,provides simple methods to control pointer component.
Definition: NexPointer.h:10
+
NexButton,subclass of NexTouch,provides simple methods to control button component.
Definition: NexButton.h:25
+
bool setValue(uint32_t number)
Set the value of pointer.
Definition: NexPointer.cpp:37
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/_comp_progress_bar_8ino_source.html b/doc/API-html/_comp_progress_bar_8ino_source.html new file mode 100644 index 00000000..302dfbc --- /dev/null +++ b/doc/API-html/_comp_progress_bar_8ino_source.html @@ -0,0 +1,138 @@ + + + + + + +API: examples/CompProgressBar/CompProgressBar.ino Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + + +
+
+
+
CompProgressBar.ino
+
+
+
1 
+
16 #include "NexProgressBar.h"
+
17 #include "NexButton.h"
+
18 
+
19 NexProgressBar j0 = NexProgressBar(0, 3, "j0");
+
20 NexButton btn_up = NexButton(0, 1, "btn_up");
+
21 NexButton btn_down = NexButton(0, 2, "btn_down");
+
22 
+
23 NexTouch *nexListenList[] =
+
24 {
+
25  &btn_up,
+
26  &btn_down,
+
27  NULL
+
28 };
+
29 
+
30 void buttonUpPopCallback(void *ptr)
+
31 {
+
32  uint32_t number = 0;
+
33  dbSerial.println("buttonUpPopCallback");
+
34 
+
35  j0.getValue(&number);
+
36 
+
37  number += 5;
+
38  if (number >= 100)
+
39  {
+
40  number = 100;
+
41  }
+
42 
+
43  j0.setValue(number);
+
44 }
+
45 void buttonDownPopCallback(void *ptr)
+
46 {
+
47  uint32_t number = 0;
+
48  dbSerial.println("buttonDownPopCallback");
+
49 
+
50  j0.getValue(&number);
+
51 
+
52  if (number >= 5)
+
53  {
+
54  number -= 5;
+
55  }
+
56 
+
57  j0.setValue(number);
+
58 }
+
59 
+
60 
+
61 
+
62 void setup(void)
+
63 {
+
64  uint32_t brightness = 0;
+
65 
+
66  dbSerial.begin(9600);
+
67  nexInit();
+
68  btn_up.attachPop(buttonUpPopCallback);
+
69  btn_down.attachPop(buttonDownPopCallback);
+
70  dbSerial.println("setup done");
+
71 }
+
72 
+
73 void loop(void)
+
74 {
+
75  dbSerial.println("nexLoop");
+
76  nexLoop(nexListenList);
+
77 }
+
78 
+
bool setValue(uint32_t number)
Set the value of progress bar.
+
bool nexInit(void)
Init Nextion's baudrate,page id.
Definition: NexTouch.cpp:423
+
API of NexButton.
+
bool nexLoop(NexTouch **nexListenList)
Call mainEventLoop,watting for Nextion's touch event.
Definition: NexTouch.cpp:440
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register button pop callback function.
Definition: NexButton.cpp:70
+
NexButton,subclass of NexTouch,provides simple methods to control button component.
Definition: NexButton.h:25
+
bool getValue(uint32_t *number)
Get the value of progress bar.
+
API of NexProgressBar.
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
NexProgressBar,subclass of NexTouch,provides simple methods to control progress bar component...
+
+ + + + diff --git a/doc/API-html/_comp_slice_8ino_source.html b/doc/API-html/_comp_slice_8ino_source.html new file mode 100644 index 00000000..3a603d2 --- /dev/null +++ b/doc/API-html/_comp_slice_8ino_source.html @@ -0,0 +1,109 @@ + + + + + + +API: examples/CompSlice/CompSlice.ino Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + + +
+
+
+
CompSlice.ino
+
+
+
1 
+
16 #include "NexSlice.h"
+
17 
+
18 NexSlice q0 = NexSlice(0, 1, "q0");
+
19 
+
20 NexTouch *nexListenList[] =
+
21 {
+
22  &q0,
+
23  NULL
+
24 };
+
25 
+
26 void q0PopCallback(void *ptr)
+
27 {
+
28  uint32_t number = 0;
+
29  dbSerial.println("q0PopCallback");
+
30 
+
31  q0.getPic(&number);
+
32 
+
33  number += 1;
+
34  number %= 2;
+
35 
+
36  q0.setPic(number);
+
37 }
+
38 
+
39 
+
40 void setup(void)
+
41 {
+
42  dbSerial.begin(9600);
+
43  nexInit();
+
44  q0.attachPop(q0PopCallback);
+
45  dbSerial.println("setup done");
+
46 }
+
47 
+
48 void loop(void)
+
49 {
+
50  dbSerial.println("nexLoop");
+
51  nexLoop(nexListenList);
+
52 }
+
53 
+
NexSlice,subclass of NexTouch,provides simple methods to control slice component. ...
Definition: NexSlice.h:25
+
bool nexInit(void)
Init Nextion's baudrate,page id.
Definition: NexTouch.cpp:423
+
bool nexLoop(NexTouch **nexListenList)
Call mainEventLoop,watting for Nextion's touch event.
Definition: NexTouch.cpp:440
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register slice pop callback function.
Definition: NexSlice.cpp:72
+
API of NexSlice.
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/_comp_text_8ino_source.html b/doc/API-html/_comp_text_8ino_source.html new file mode 100644 index 00000000..390a8fb --- /dev/null +++ b/doc/API-html/_comp_text_8ino_source.html @@ -0,0 +1,152 @@ + + + + + + +API: examples/CompText/CompText.ino Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + + +
+
+
+
CompText.ino
+
+
+
1 
+
16 #include "NexButton.h"
+
17 #include "NexText.h"
+
18 
+
19 void t0PopCallback(void *ptr);
+
20 void b0PopCallback(void *ptr);
+
21 void b1PopCallback(void *ptr);
+
22 
+
23 NexText t0 = NexText(0, 1, "t0", t0PopCallback);
+
24 NexButton b0 = NexButton(0, 2, "b0", b0PopCallback);
+
25 NexButton b1 = NexButton(0, 3, "b1", b1PopCallback);
+
26 
+
27 char buffer[100] = {0};
+
28 
+
29 NexTouch *nexListenList[] =
+
30 {
+
31  &t0,
+
32  &b0,
+
33  &b1,
+
34  NULL
+
35 };
+
36 
+
37 void t0PopCallback(void *ptr)
+
38 {
+
39  dbSerial.println("t0PopCallback");
+
40  t0.setText("50");
+
41 }
+
42 
+
43 void b0PopCallback(void *ptr)
+
44 {
+
45  uint16_t len;
+
46  uint16_t number;
+
47 
+
48  dbSerial.println("b0PopCallback");
+
49 
+
50  memset(buffer, 0, sizeof(buffer));
+
51  t0.getText(buffer, sizeof(buffer));
+
52 
+
53  number = atoi(buffer);
+
54  number += 1;
+
55 
+
56  memset(buffer, 0, sizeof(buffer));
+
57  itoa(number, buffer, 10);
+
58 
+
59  t0.setText(buffer);
+
60 }
+
61 
+
62 void b1PopCallback(void *ptr)
+
63 {
+
64  uint16_t len;
+
65  uint16_t number;
+
66 
+
67  dbSerial.println("b1PopCallback");
+
68 
+
69  memset(buffer, 0, sizeof(buffer));
+
70  t0.getText(buffer, sizeof(buffer));
+
71 
+
72  number = atoi(buffer);
+
73  number -= 1;
+
74 
+
75  memset(buffer, 0, sizeof(buffer));
+
76  itoa(number, buffer, 10);
+
77 
+
78  t0.setText(buffer);
+
79 }
+
80 
+
81 void setup(void)
+
82 {
+
83  dbSerial.begin(9600);
+
84  nexInit();
+
85  dbSerial.println("setup done");
+
86 }
+
87 
+
88 void loop(void)
+
89 {
+
90  dbSerial.println("nexLoop");
+
91  nexLoop(nexListenList);
+
92 }
+
93 
+
bool setText(const char *buffer)
Set the value of text.
Definition: NexText.cpp:53
+
bool nexInit(void)
Init Nextion's baudrate,page id.
Definition: NexTouch.cpp:423
+
API of NexText.
+
API of NexButton.
+
bool nexLoop(NexTouch **nexListenList)
Call mainEventLoop,watting for Nextion's touch event.
Definition: NexTouch.cpp:440
+
NexButton,subclass of NexTouch,provides simple methods to control button component.
Definition: NexButton.h:25
+
uint16_t getText(char *buffer, uint16_t len)
Get the value of text.
Definition: NexText.cpp:35
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
NexText,subclass of NexTouch,provides simple methods to control text component.
Definition: NexText.h:25
+
+ + + + diff --git a/doc/API-html/_nex_button_8cpp.html b/doc/API-html/_nex_button_8cpp.html new file mode 100644 index 00000000..dd85e69 --- /dev/null +++ b/doc/API-html/_nex_button_8cpp.html @@ -0,0 +1,74 @@ + + + + + + +API: NexButton.cpp File Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexButton.cpp File Reference
+
+
+ +

API of NexButton. +More...

+
#include "NexButton.h"
+
+

Go to the source code of this file.

+

Detailed Description

+

API of NexButton.

+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ + +

Definition in file NexButton.cpp.

+
+ + + + diff --git a/doc/API-html/_nex_button_8cpp_source.html b/doc/API-html/_nex_button_8cpp_source.html new file mode 100644 index 00000000..6e7950d --- /dev/null +++ b/doc/API-html/_nex_button_8cpp_source.html @@ -0,0 +1,111 @@ + + + + + + +API: NexButton.cpp Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexButton.cpp
+
+
+Go to the documentation of this file.
1 
+
16 #include "NexButton.h"
+
17 
+
22 NexButton::NexButton(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop, void *pop_ptr)
+
23  :NexTouch(pid, cid, name, pop, pop_ptr)
+
24 {
+
25 }
+
26 
+
35 uint16_t NexButton::getText(char *buffer, uint16_t len)
+
36 {
+
37  String cmd;
+
38  cmd += "get ";
+
39  cmd += getObjName();
+
40  cmd += ".txt";
+
41  sendCommand(cmd.c_str());
+
42  return recvRetString(buffer,len);
+
43 }
+
44 
+
53 bool NexButton::setText(const char *buffer)
+
54 {
+
55  String cmd;
+
56  cmd += getObjName();
+
57  cmd += ".txt=\"";
+
58  cmd += buffer;
+
59  cmd += "\"";
+
60  sendCommand(cmd.c_str());
+
61  return recvRetCommandFinished();
+
62 }
+
63 
+
70 void NexButton::attachPop(NexTouchEventCb pop, void *ptr)
+
71 {
+
72  NexTouch::attachPop(pop, ptr);
+
73 }
+
74 
+ +
80 {
+
81  NexTouch::detachPop();
+
82 }
+
83 
+
84 
+
NexButton(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)
Constructor,inherited NexTouch's constructor function.
Definition: NexButton.cpp:22
+
uint16_t getText(char *buffer, uint16_t len)
Get text value from button component.
Definition: NexButton.cpp:35
+
API of NexButton.
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register button pop callback function.
Definition: NexButton.cpp:70
+
static void sendCommand(const char *cmd)
Send command to Nextion.
Definition: NexTouch.cpp:261
+
const char * getObjName(void)
Get component name.
Definition: NexTouch.cpp:112
+
bool setText(const char *buffer)
Set text value of button component.
Definition: NexButton.cpp:53
+
static uint16_t recvRetString(char *buffer, uint16_t len, uint32_t timeout=500)
Receive string data.
Definition: NexTouch.cpp:284
+
void detachPop(void)
Unload button pop callback function.
Definition: NexButton.cpp:79
+
static bool recvRetCommandFinished(uint32_t timeout=100)
Command is executed successfully.
Definition: NexTouch.cpp:224
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/_nex_button_8h.html b/doc/API-html/_nex_button_8h.html new file mode 100644 index 00000000..d7c37ca --- /dev/null +++ b/doc/API-html/_nex_button_8h.html @@ -0,0 +1,83 @@ + + + + + + +API: NexButton.h File Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Classes
+
+
NexButton.h File Reference
+
+
+ +

API of NexButton. +More...

+
#include "NexTouch.h"
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  NexButton
 NexButton,subclass of NexTouch,provides simple methods to control button component. More...
 
+

Detailed Description

+

API of NexButton.

+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ + +

Definition in file NexButton.h.

+
+ + + + diff --git a/doc/API-html/_nex_button_8h_source.html b/doc/API-html/_nex_button_8h_source.html new file mode 100644 index 00000000..29d33a6 --- /dev/null +++ b/doc/API-html/_nex_button_8h_source.html @@ -0,0 +1,88 @@ + + + + + + +API: NexButton.h Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexButton.h
+
+
+Go to the documentation of this file.
1 
+
16 #ifndef __NEXBUTTON_H__
+
17 #define __NEXBUTTON_H__
+
18 #ifdef __cplusplus
+
19 #include "NexTouch.h"
+
20 
+
25 class NexButton: public NexTouch
+
26 {
+
27 public: /* methods */
+
28  NexButton(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop = NULL, void *pop_ptr = NULL);
+
29 
+
30  void attachPop(NexTouchEventCb pop, void *ptr = NULL);
+
31  void detachPop(void);
+
32 
+
33  uint16_t getText(char *buffer, uint16_t len);
+
34  bool setText(const char *buffer);
+
35 };
+
36 
+
37 #endif /* #ifdef __cplusplus */
+
38 #endif /* #ifndef __NEXBUTTON_H__ */
+
NexButton(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)
Constructor,inherited NexTouch's constructor function.
Definition: NexButton.cpp:22
+
uint16_t getText(char *buffer, uint16_t len)
Get text value from button component.
Definition: NexButton.cpp:35
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register button pop callback function.
Definition: NexButton.cpp:70
+
NexButton,subclass of NexTouch,provides simple methods to control button component.
Definition: NexButton.h:25
+
bool setText(const char *buffer)
Set text value of button component.
Definition: NexButton.cpp:53
+
API of Nextion.
+
void detachPop(void)
Unload button pop callback function.
Definition: NexButton.cpp:79
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/_nex_hotspot_8cpp.html b/doc/API-html/_nex_hotspot_8cpp.html new file mode 100644 index 00000000..13abf67 --- /dev/null +++ b/doc/API-html/_nex_hotspot_8cpp.html @@ -0,0 +1,74 @@ + + + + + + +API: NexHotspot.cpp File Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexHotspot.cpp File Reference
+
+
+ +

API of NexHotspot. +More...

+
#include "NexHotspot.h"
+
+

Go to the source code of this file.

+

Detailed Description

+

API of NexHotspot.

+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ + +

Definition in file NexHotspot.cpp.

+
+ + + + diff --git a/doc/API-html/_nex_hotspot_8cpp_source.html b/doc/API-html/_nex_hotspot_8cpp_source.html new file mode 100644 index 00000000..5fd667a --- /dev/null +++ b/doc/API-html/_nex_hotspot_8cpp_source.html @@ -0,0 +1,96 @@ + + + + + + +API: NexHotspot.cpp Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexHotspot.cpp
+
+
+Go to the documentation of this file.
1 
+
16 #include "NexHotspot.h"
+
17 
+
22 NexHotspot::NexHotspot(NexPid pid, NexCid cid, char *name,
+
23  NexTouchEventCb pop, void *pop_ptr,
+
24  NexTouchEventCb push, void *push_ptr)
+
25  :NexTouch(pid, cid, name, pop, pop_ptr, push, push_ptr)
+
26 {
+
27 }
+
28 
+
35 void NexHotspot::attachPush(NexTouchEventCb push, void *ptr)
+
36 {
+
37  NexTouch::attachPush(push, ptr);
+
38 }
+
39 
+ +
45 {
+
46  NexTouch::detachPush();
+
47 }
+
48 
+
55 void NexHotspot::attachPop(NexTouchEventCb pop, void *ptr)
+
56 {
+
57  NexTouch::attachPop(pop, ptr);
+
58 }
+
59 
+ +
65 {
+
66  NexTouch::detachPop();
+
67 }
+
void detachPop(void)
Unload hotsopt pop callback function.
Definition: NexHotspot.cpp:64
+
void detachPush(void)
Unload hotsopt push callback function.
Definition: NexHotspot.cpp:44
+
NexHotspot(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)
Constructor,inherited NexTouch's constructor function.
Definition: NexHotspot.cpp:22
+
API of NexHotspot.
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register hotspot pop callback function.
Definition: NexHotspot.cpp:55
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
void attachPush(NexTouchEventCb push, void *ptr=NULL)
Register hotspot push callback function.
Definition: NexHotspot.cpp:35
+
+ + + + diff --git a/doc/API-html/_nex_hotspot_8h.html b/doc/API-html/_nex_hotspot_8h.html new file mode 100644 index 00000000..3aea44f --- /dev/null +++ b/doc/API-html/_nex_hotspot_8h.html @@ -0,0 +1,83 @@ + + + + + + +API: NexHotspot.h File Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Classes
+
+
NexHotspot.h File Reference
+
+
+ +

API of NexHotspot. +More...

+
#include "NexTouch.h"
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  NexHotspot
 NexHotspot,subclass of NexTouch,provides simple methods to control hotspot component. More...
 
+

Detailed Description

+

API of NexHotspot.

+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ + +

Definition in file NexHotspot.h.

+
+ + + + diff --git a/doc/API-html/_nex_hotspot_8h_source.html b/doc/API-html/_nex_hotspot_8h_source.html new file mode 100644 index 00000000..cef5634 --- /dev/null +++ b/doc/API-html/_nex_hotspot_8h_source.html @@ -0,0 +1,90 @@ + + + + + + +API: NexHotspot.h Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexHotspot.h
+
+
+Go to the documentation of this file.
1 
+
16 #ifndef __NEXHOTSPOT_H__
+
17 #define __NEXHOTSPOT_H__
+
18 #ifdef __cplusplus
+
19 #include "NexTouch.h"
+
20 
+
25 class NexHotspot: public NexTouch
+
26 {
+
27 public: /* methods */
+
28  NexHotspot(NexPid pid, NexCid cid, char *name,
+
29  NexTouchEventCb pop = NULL, void *pop_ptr = NULL,
+
30  NexTouchEventCb push = NULL, void *push_ptr = NULL);
+
31 
+
32  void attachPush(NexTouchEventCb push, void *ptr = NULL);
+
33  void detachPush(void);
+
34  void attachPop(NexTouchEventCb pop, void *ptr = NULL);
+
35  void detachPop(void);
+
36 
+
37 };
+
38 
+
39 #endif /* #ifdef __cplusplus */
+
40 #endif /* #ifndef __NEXHOTSPOT_H__ */
+
void detachPop(void)
Unload hotsopt pop callback function.
Definition: NexHotspot.cpp:64
+
void detachPush(void)
Unload hotsopt push callback function.
Definition: NexHotspot.cpp:44
+
API of Nextion.
+
NexHotspot(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)
Constructor,inherited NexTouch's constructor function.
Definition: NexHotspot.cpp:22
+
NexHotspot,subclass of NexTouch,provides simple methods to control hotspot component.
Definition: NexHotspot.h:25
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register hotspot pop callback function.
Definition: NexHotspot.cpp:55
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
void attachPush(NexTouchEventCb push, void *ptr=NULL)
Register hotspot push callback function.
Definition: NexHotspot.cpp:35
+
+ + + + diff --git a/doc/API-html/_nex_page_8cpp.html b/doc/API-html/_nex_page_8cpp.html new file mode 100644 index 00000000..df35f31 --- /dev/null +++ b/doc/API-html/_nex_page_8cpp.html @@ -0,0 +1,74 @@ + + + + + + +API: NexPage.cpp File Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexPage.cpp File Reference
+
+
+ +

API of NexPage. +More...

+
#include "NexPage.h"
+
+

Go to the source code of this file.

+

Detailed Description

+

API of NexPage.

+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ + +

Definition in file NexPage.cpp.

+
+ + + + diff --git a/doc/API-html/_nex_page_8cpp_source.html b/doc/API-html/_nex_page_8cpp_source.html new file mode 100644 index 00000000..cc76038 --- /dev/null +++ b/doc/API-html/_nex_page_8cpp_source.html @@ -0,0 +1,102 @@ + + + + + + +API: NexPage.cpp Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexPage.cpp
+
+
+Go to the documentation of this file.
1 
+
16 #include "NexPage.h"
+
17 
+
22 NexPage::NexPage(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop, void *pop_ptr)
+
23  :NexTouch(pid, cid, name, pop, pop_ptr)
+
24 {
+
25 }
+
26 
+
33 bool NexPage::show(void)
+
34 {
+
35  uint8_t buffer[4] = {0};
+
36 
+
37  const char *name = getObjName();
+
38  if (!name)
+
39  {
+
40  return false;
+
41  }
+
42 
+
43  String cmd = String("page ");
+
44  cmd += name;
+
45  sendCommand(cmd.c_str());
+
46  return recvRetCommandFinished();
+
47 }
+
48 
+
55 void NexPage::attachPop(NexTouchEventCb pop, void *ptr)
+
56 {
+
57  NexTouch::attachPop(pop, ptr);
+
58 }
+
59 
+ +
65 {
+
66  NexTouch::detachPop();
+
67 }
+
void detachPop(void)
Unload page pop callback function.
Definition: NexPage.cpp:64
+
bool show(void)
Change page.
Definition: NexPage.cpp:33
+
static void sendCommand(const char *cmd)
Send command to Nextion.
Definition: NexTouch.cpp:261
+
const char * getObjName(void)
Get component name.
Definition: NexTouch.cpp:112
+
API of NexPage.
+
NexPage(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)
Constructor,inherited NexTouch's constructor function.
Definition: NexPage.cpp:22
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register page pop callback function.
Definition: NexPage.cpp:55
+
static bool recvRetCommandFinished(uint32_t timeout=100)
Command is executed successfully.
Definition: NexTouch.cpp:224
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/_nex_page_8h.html b/doc/API-html/_nex_page_8h.html new file mode 100644 index 00000000..8b245c1 --- /dev/null +++ b/doc/API-html/_nex_page_8h.html @@ -0,0 +1,83 @@ + + + + + + +API: NexPage.h File Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Classes
+
+
NexPage.h File Reference
+
+
+ +

API of NexPage. +More...

+
#include "NexTouch.h"
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  NexPage
 NexPage,subclass of NexTouch,provides simple methods to control page component. More...
 
+

Detailed Description

+

API of NexPage.

+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ + +

Definition in file NexPage.h.

+
+ + + + diff --git a/doc/API-html/_nex_page_8h_source.html b/doc/API-html/_nex_page_8h_source.html new file mode 100644 index 00000000..486d8b0 --- /dev/null +++ b/doc/API-html/_nex_page_8h_source.html @@ -0,0 +1,86 @@ + + + + + + +API: NexPage.h Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexPage.h
+
+
+Go to the documentation of this file.
1 
+
16 #ifndef __NEXPAGE_H__
+
17 #define __NEXPAGE_H__
+
18 #ifdef __cplusplus
+
19 #include "NexTouch.h"
+
20 
+
25 class NexPage: public NexTouch
+
26 {
+
27 public: /* methods */
+
28  NexPage(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop = NULL, void *pop_ptr = NULL);
+
29  bool show(void);
+
30 
+
31  void attachPop(NexTouchEventCb pop, void *ptr = NULL);
+
32  void detachPop(void);
+
33 
+
34 };
+
35 
+
36 #endif /* #ifdef __cplusplus */
+
37 #endif /* #ifndef __NEXPAGE_H__ */
+
void detachPop(void)
Unload page pop callback function.
Definition: NexPage.cpp:64
+
bool show(void)
Change page.
Definition: NexPage.cpp:33
+
NexPage,subclass of NexTouch,provides simple methods to control page component.
Definition: NexPage.h:25
+
API of Nextion.
+
NexPage(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)
Constructor,inherited NexTouch's constructor function.
Definition: NexPage.cpp:22
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register page pop callback function.
Definition: NexPage.cpp:55
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/_nex_picture_8cpp.html b/doc/API-html/_nex_picture_8cpp.html new file mode 100644 index 00000000..2abe035 --- /dev/null +++ b/doc/API-html/_nex_picture_8cpp.html @@ -0,0 +1,74 @@ + + + + + + +API: NexPicture.cpp File Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexPicture.cpp File Reference
+
+
+ +

API of NexPicture. +More...

+
#include "NexPicture.h"
+
+

Go to the source code of this file.

+

Detailed Description

+

API of NexPicture.

+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ + +

Definition in file NexPicture.cpp.

+
+ + + + diff --git a/doc/API-html/_nex_picture_8cpp_source.html b/doc/API-html/_nex_picture_8cpp_source.html new file mode 100644 index 00000000..c2e5b25 --- /dev/null +++ b/doc/API-html/_nex_picture_8cpp_source.html @@ -0,0 +1,112 @@ + + + + + + +API: NexPicture.cpp Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexPicture.cpp
+
+
+Go to the documentation of this file.
1 
+
16 #include "NexPicture.h"
+
17 
+
22 NexPicture::NexPicture(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop, void *pop_ptr)
+
23  :NexTouch(pid, cid, name, pop, pop_ptr)
+
24 {
+
25 }
+
26 
+
35 bool NexPicture::getPic(uint32_t *number)
+
36 {
+
37  String cmd = String("get ");
+
38  cmd += getObjName();
+
39  cmd += ".pic";
+
40  sendCommand(cmd.c_str());
+
41  return recvRetNumber(number);
+
42 }
+
43 
+
52 bool NexPicture::setPic(uint32_t number)
+
53 {
+
54  char buf[10] = {0};
+
55  String cmd;
+
56 
+
57  utoa(number, buf, 10);
+
58  cmd += getObjName();
+
59  cmd += ".pic=";
+
60  cmd += buf;
+
61 
+
62  sendCommand(cmd.c_str());
+
63  return recvRetCommandFinished();
+
64 }
+
65 
+
72 void NexPicture::attachPop(NexTouchEventCb pop, void *ptr)
+
73 {
+
74  NexTouch::attachPop(pop, ptr);
+
75 }
+
76 
+ +
82 {
+
83  NexTouch::detachPop();
+
84 }
+
85 
+
void detachPop(void)
Unload picture pop callback function.
Definition: NexPicture.cpp:81
+
bool setPic(uint32_t number)
Set picture's number.
Definition: NexPicture.cpp:52
+
NexPicture(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)
Constructor,inherited NexTouch's constructor function.
Definition: NexPicture.cpp:22
+
static void sendCommand(const char *cmd)
Send command to Nextion.
Definition: NexTouch.cpp:261
+
const char * getObjName(void)
Get component name.
Definition: NexTouch.cpp:112
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register picture pop callback function.
Definition: NexPicture.cpp:72
+
static bool recvRetNumber(uint32_t *number, uint32_t timeout=500)
Receive uint32_t data.
Definition: NexTouch.cpp:356
+
static bool recvRetCommandFinished(uint32_t timeout=100)
Command is executed successfully.
Definition: NexTouch.cpp:224
+
bool getPic(uint32_t *number)
Get picture's number.
Definition: NexPicture.cpp:35
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
API of NexPicture.
+
+ + + + diff --git a/doc/API-html/_nex_picture_8h.html b/doc/API-html/_nex_picture_8h.html new file mode 100644 index 00000000..9782df8 --- /dev/null +++ b/doc/API-html/_nex_picture_8h.html @@ -0,0 +1,83 @@ + + + + + + +API: NexPicture.h File Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Classes
+
+
NexPicture.h File Reference
+
+
+ +

API of NexPicture. +More...

+
#include "NexTouch.h"
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  NexPicture
 NexPicture,subclass of NexTouch,provides simple methods to control picture component. More...
 
+

Detailed Description

+

API of NexPicture.

+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ + +

Definition in file NexPicture.h.

+
+ + + + diff --git a/doc/API-html/_nex_picture_8h_source.html b/doc/API-html/_nex_picture_8h_source.html new file mode 100644 index 00000000..fd5ee93 --- /dev/null +++ b/doc/API-html/_nex_picture_8h_source.html @@ -0,0 +1,88 @@ + + + + + + +API: NexPicture.h Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexPicture.h
+
+
+Go to the documentation of this file.
1 
+
16 #ifndef __NEXPICTURE_H__
+
17 #define __NEXPICTURE_H__
+
18 #ifdef __cplusplus
+
19 #include "NexTouch.h"
+
20 
+
25 class NexPicture: public NexTouch
+
26 {
+
27 public: /* methods */
+
28  NexPicture(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop = NULL, void *pop_ptr = NULL);
+
29 
+
30  void attachPop(NexTouchEventCb pop, void *ptr = NULL);
+
31  void detachPop(void);
+
32 
+
33  bool getPic(uint32_t *number);
+
34  bool setPic(uint32_t number);
+
35 };
+
36 
+
37 #endif /* #ifdef __cplusplus */
+
38 #endif /* #ifndef __NEXPICTURE_H__ */
+
void detachPop(void)
Unload picture pop callback function.
Definition: NexPicture.cpp:81
+
bool setPic(uint32_t number)
Set picture's number.
Definition: NexPicture.cpp:52
+
NexPicture(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)
Constructor,inherited NexTouch's constructor function.
Definition: NexPicture.cpp:22
+
NexPicture,subclass of NexTouch,provides simple methods to control picture component.
Definition: NexPicture.h:25
+
API of Nextion.
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register picture pop callback function.
Definition: NexPicture.cpp:72
+
bool getPic(uint32_t *number)
Get picture's number.
Definition: NexPicture.cpp:35
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/_nex_pointer_8cpp_source.html b/doc/API-html/_nex_pointer_8cpp_source.html new file mode 100644 index 00000000..cb46b16 --- /dev/null +++ b/doc/API-html/_nex_pointer_8cpp_source.html @@ -0,0 +1,98 @@ + + + + + + +API: NexPointer.cpp Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexPointer.cpp
+
+
+
1 #include "NexPointer.h"
+
2 
+
7 NexPointer::NexPointer(NexPid pid, NexCid cid, char *name)
+
8  :NexTouch(pid, cid, name)
+
9 {
+
10 }
+
11 
+
20 bool NexPointer::getValue(uint32_t *number)
+
21 {
+
22  String cmd = String("get ");
+
23  cmd += getObjName();
+
24  cmd += ".val";
+
25  sendCommand(cmd.c_str());
+
26  return recvRetNumber(number);
+
27 }
+
28 
+
37 bool NexPointer::setValue(uint32_t number)
+
38 {
+
39  char buf[10] = {0};
+
40  String cmd;
+
41 
+
42  utoa(number, buf, 10);
+
43  cmd += getObjName();
+
44  cmd += ".val=";
+
45  cmd += buf;
+
46 
+
47  sendCommand(cmd.c_str());
+
48  return recvRetCommandFinished();
+
49 }
+
50 
+
bool getValue(uint32_t *number)
Get the value of pointer.
Definition: NexPointer.cpp:20
+
static void sendCommand(const char *cmd)
Send command to Nextion.
Definition: NexTouch.cpp:261
+
const char * getObjName(void)
Get component name.
Definition: NexTouch.cpp:112
+
static bool recvRetNumber(uint32_t *number, uint32_t timeout=500)
Receive uint32_t data.
Definition: NexTouch.cpp:356
+
NexPointer(NexPid pid, NexCid cid, char *name)
Constructor,inherited NexTouch's constructor function.
Definition: NexPointer.cpp:7
+
bool setValue(uint32_t number)
Set the value of pointer.
Definition: NexPointer.cpp:37
+
static bool recvRetCommandFinished(uint32_t timeout=100)
Command is executed successfully.
Definition: NexTouch.cpp:224
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/_nex_pointer_8h_source.html b/doc/API-html/_nex_pointer_8h_source.html new file mode 100644 index 00000000..f08691b --- /dev/null +++ b/doc/API-html/_nex_pointer_8h_source.html @@ -0,0 +1,82 @@ + + + + + + +API: NexPointer.h Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexPointer.h
+
+
+
1 #ifndef __NEXPOINTER_H__
+
2 #define __NEXPOINTER_H__
+
3 #ifdef __cplusplus
+
4 #include "NexTouch.h"
+
5 
+
10 class NexPointer: public NexTouch
+
11 {
+
12 public: /* methods */
+
13  NexPointer(NexPid pid, NexCid cid, char *name);
+
14 
+
15  bool getValue(uint32_t *number);
+
16  bool setValue(uint32_t number);
+
17 };
+
18 
+
19 #endif /* #ifdef __cplusplus */
+
20 #endif /* #ifndef __NEXPOINTER_H__ */
+
bool getValue(uint32_t *number)
Get the value of pointer.
Definition: NexPointer.cpp:20
+
NexPointer,subclass of NexTouch,provides simple methods to control pointer component.
Definition: NexPointer.h:10
+
API of Nextion.
+
NexPointer(NexPid pid, NexCid cid, char *name)
Constructor,inherited NexTouch's constructor function.
Definition: NexPointer.cpp:7
+
bool setValue(uint32_t number)
Set the value of pointer.
Definition: NexPointer.cpp:37
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/_nex_progress_bar_8cpp.html b/doc/API-html/_nex_progress_bar_8cpp.html new file mode 100644 index 00000000..31c9468 --- /dev/null +++ b/doc/API-html/_nex_progress_bar_8cpp.html @@ -0,0 +1,74 @@ + + + + + + +API: NexProgressBar.cpp File Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexProgressBar.cpp File Reference
+
+
+ +

API of NexProgressBar. +More...

+
#include "NexProgressBar.h"
+
+

Go to the source code of this file.

+

Detailed Description

+

API of NexProgressBar.

+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ + +

Definition in file NexProgressBar.cpp.

+
+ + + + diff --git a/doc/API-html/_nex_progress_bar_8cpp_source.html b/doc/API-html/_nex_progress_bar_8cpp_source.html new file mode 100644 index 00000000..3ebd90d --- /dev/null +++ b/doc/API-html/_nex_progress_bar_8cpp_source.html @@ -0,0 +1,100 @@ + + + + + + +API: NexProgressBar.cpp Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexProgressBar.cpp
+
+
+Go to the documentation of this file.
1 
+
16 #include "NexProgressBar.h"
+
17 
+
22 NexProgressBar::NexProgressBar(NexPid pid, NexCid cid, char *name)
+
23  :NexTouch(pid, cid, name)
+
24 {
+
25 }
+
26 
+
35 bool NexProgressBar::getValue(uint32_t *number)
+
36 {
+
37  String cmd = String("get ");
+
38  cmd += getObjName();
+
39  cmd += ".val";
+
40  sendCommand(cmd.c_str());
+
41  return recvRetNumber(number);
+
42 }
+
43 
+
52 bool NexProgressBar::setValue(uint32_t number)
+
53 {
+
54  char buf[10] = {0};
+
55  String cmd;
+
56 
+
57  utoa(number, buf, 10);
+
58  cmd += getObjName();
+
59  cmd += ".val=";
+
60  cmd += buf;
+
61 
+
62  sendCommand(cmd.c_str());
+
63  return recvRetCommandFinished();
+
64 }
+
65 
+
bool setValue(uint32_t number)
Set the value of progress bar.
+
static void sendCommand(const char *cmd)
Send command to Nextion.
Definition: NexTouch.cpp:261
+
const char * getObjName(void)
Get component name.
Definition: NexTouch.cpp:112
+
bool getValue(uint32_t *number)
Get the value of progress bar.
+
static bool recvRetNumber(uint32_t *number, uint32_t timeout=500)
Receive uint32_t data.
Definition: NexTouch.cpp:356
+
NexProgressBar(NexPid pid, NexCid cid, char *name)
Constructor,inherited NexTouch's constructor function.
+
static bool recvRetCommandFinished(uint32_t timeout=100)
Command is executed successfully.
Definition: NexTouch.cpp:224
+
API of NexProgressBar.
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/_nex_progress_bar_8h.html b/doc/API-html/_nex_progress_bar_8h.html new file mode 100644 index 00000000..2275bae --- /dev/null +++ b/doc/API-html/_nex_progress_bar_8h.html @@ -0,0 +1,83 @@ + + + + + + +API: NexProgressBar.h File Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Classes
+
+
NexProgressBar.h File Reference
+
+
+ +

API of NexProgressBar. +More...

+
#include "NexTouch.h"
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  NexProgressBar
 NexProgressBar,subclass of NexTouch,provides simple methods to control progress bar component. More...
 
+

Detailed Description

+

API of NexProgressBar.

+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ + +

Definition in file NexProgressBar.h.

+
+ + + + diff --git a/doc/API-html/_nex_progress_bar_8h_source.html b/doc/API-html/_nex_progress_bar_8h_source.html new file mode 100644 index 00000000..cffd730 --- /dev/null +++ b/doc/API-html/_nex_progress_bar_8h_source.html @@ -0,0 +1,83 @@ + + + + + + +API: NexProgressBar.h Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexProgressBar.h
+
+
+Go to the documentation of this file.
1 
+
16 #ifndef __NEXPROGRESSBAR_H__
+
17 #define __NEXPROGRESSBAR_H__
+
18 #ifdef __cplusplus
+
19 #include "NexTouch.h"
+
20 
+
25 class NexProgressBar: public NexTouch
+
26 {
+
27 public: /* methods */
+
28  NexProgressBar(NexPid pid, NexCid cid, char *name);
+
29 
+
30  bool getValue(uint32_t *number);
+
31  bool setValue(uint32_t number);
+
32 };
+
33 
+
34 #endif /* #ifdef __cplusplus */
+
35 #endif /* #ifndef __NEXPROGRESSBAR_H__ */
+
bool setValue(uint32_t number)
Set the value of progress bar.
+
API of Nextion.
+
bool getValue(uint32_t *number)
Get the value of progress bar.
+
NexProgressBar(NexPid pid, NexCid cid, char *name)
Constructor,inherited NexTouch's constructor function.
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
NexProgressBar,subclass of NexTouch,provides simple methods to control progress bar component...
+
+ + + + diff --git a/doc/API-html/_nex_slice_8cpp.html b/doc/API-html/_nex_slice_8cpp.html new file mode 100644 index 00000000..9de7767 --- /dev/null +++ b/doc/API-html/_nex_slice_8cpp.html @@ -0,0 +1,74 @@ + + + + + + +API: NexSlice.cpp File Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexSlice.cpp File Reference
+
+
+ +

API of NexSlice. +More...

+
#include "NexSlice.h"
+
+

Go to the source code of this file.

+

Detailed Description

+

API of NexSlice.

+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ + +

Definition in file NexSlice.cpp.

+
+ + + + diff --git a/doc/API-html/_nex_slice_8cpp_source.html b/doc/API-html/_nex_slice_8cpp_source.html new file mode 100644 index 00000000..5000140 --- /dev/null +++ b/doc/API-html/_nex_slice_8cpp_source.html @@ -0,0 +1,126 @@ + + + + + + +API: NexSlice.cpp Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexSlice.cpp
+
+
+Go to the documentation of this file.
1 
+
16 #include "NexSlice.h"
+
17 
+
22 NexSlice::NexSlice(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop, void *pop_ptr)
+
23  :NexTouch(pid, cid, name, pop, pop_ptr)
+
24 {
+
25 }
+
26 
+
27 /*
+
28  * Get the number of picture.
+
29  *
+
30  * @param number - an output parameter to save the number of picture.
+
31  *
+
32  * @retval true - success.
+
33  * @retval false - failed.
+
34  */
+
35 bool NexSlice::getPic(uint32_t *number)
+
36 {
+
37  String cmd = String("get ");
+
38  cmd += getObjName();
+
39  cmd += ".picc";
+
40  sendCommand(cmd.c_str());
+
41  return recvRetNumber(number);
+
42 }
+
43 
+
44 /*
+
45  * Set the number of picture.
+
46  *
+
47  * @param number - the number of picture.
+
48  *
+
49  * @retval true - success.
+
50  * @retval false - failed.
+
51  */
+
52 bool NexSlice::setPic(uint32_t number)
+
53 {
+
54  char buf[10] = {0};
+
55  String cmd;
+
56 
+
57  utoa(number, buf, 10);
+
58  cmd += getObjName();
+
59  cmd += ".picc=";
+
60  cmd += buf;
+
61 
+
62  sendCommand(cmd.c_str());
+
63  return recvRetCommandFinished();
+
64 }
+
65 
+
72 void NexSlice::attachPop(NexTouchEventCb pop, void *ptr)
+
73 {
+
74  NexTouch::attachPop(pop, ptr);
+
75 }
+
76 
+ +
82 {
+
83  NexTouch::detachPop();
+
84 }
+
85 
+
void detachPop(void)
Unload slice pop callback function.
Definition: NexSlice.cpp:81
+
static void sendCommand(const char *cmd)
Send command to Nextion.
Definition: NexTouch.cpp:261
+
const char * getObjName(void)
Get component name.
Definition: NexTouch.cpp:112
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register slice pop callback function.
Definition: NexSlice.cpp:72
+
API of NexSlice.
+
NexSlice(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)
Constructor,inherited NexTouch's constructor function.
Definition: NexSlice.cpp:22
+
static bool recvRetNumber(uint32_t *number, uint32_t timeout=500)
Receive uint32_t data.
Definition: NexTouch.cpp:356
+
static bool recvRetCommandFinished(uint32_t timeout=100)
Command is executed successfully.
Definition: NexTouch.cpp:224
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/_nex_slice_8h.html b/doc/API-html/_nex_slice_8h.html new file mode 100644 index 00000000..8e0d083 --- /dev/null +++ b/doc/API-html/_nex_slice_8h.html @@ -0,0 +1,83 @@ + + + + + + +API: NexSlice.h File Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Classes
+
+
NexSlice.h File Reference
+
+
+ +

API of NexSlice. +More...

+
#include "NexTouch.h"
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  NexSlice
 NexSlice,subclass of NexTouch,provides simple methods to control slice component. More...
 
+

Detailed Description

+

API of NexSlice.

+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ + +

Definition in file NexSlice.h.

+
+ + + + diff --git a/doc/API-html/_nex_slice_8h_source.html b/doc/API-html/_nex_slice_8h_source.html new file mode 100644 index 00000000..c2caa77 --- /dev/null +++ b/doc/API-html/_nex_slice_8h_source.html @@ -0,0 +1,86 @@ + + + + + + +API: NexSlice.h Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexSlice.h
+
+
+Go to the documentation of this file.
1 
+
16 #ifndef __NEXSLICE_H__
+
17 #define __NEXSLICE_H__
+
18 #ifdef __cplusplus
+
19 #include "NexTouch.h"
+
20 
+
25 class NexSlice: public NexTouch
+
26 {
+
27 public: /* methods */
+
28  NexSlice(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop = NULL, void *pop_ptr = NULL);
+
29 
+
30  void attachPop(NexTouchEventCb pop, void *ptr = NULL);
+
31  void detachPop(void);
+
32 
+
33  bool getPic(uint32_t *number);
+
34  bool setPic(uint32_t number);
+
35 };
+
36 
+
37 #endif /* #ifdef __cplusplus */
+
38 #endif /* #ifndef __NEXSLICE_H__ */
+
NexSlice,subclass of NexTouch,provides simple methods to control slice component. ...
Definition: NexSlice.h:25
+
void detachPop(void)
Unload slice pop callback function.
Definition: NexSlice.cpp:81
+
API of Nextion.
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register slice pop callback function.
Definition: NexSlice.cpp:72
+
NexSlice(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)
Constructor,inherited NexTouch's constructor function.
Definition: NexSlice.cpp:22
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/_nex_text_8cpp.html b/doc/API-html/_nex_text_8cpp.html new file mode 100644 index 00000000..7d38557 --- /dev/null +++ b/doc/API-html/_nex_text_8cpp.html @@ -0,0 +1,74 @@ + + + + + + +API: NexText.cpp File Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexText.cpp File Reference
+
+
+ +

API of NexText. +More...

+
#include "NexText.h"
+
+

Go to the source code of this file.

+

Detailed Description

+

API of NexText.

+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ + +

Definition in file NexText.cpp.

+
+ + + + diff --git a/doc/API-html/_nex_text_8cpp_source.html b/doc/API-html/_nex_text_8cpp_source.html new file mode 100644 index 00000000..81bcb44 --- /dev/null +++ b/doc/API-html/_nex_text_8cpp_source.html @@ -0,0 +1,110 @@ + + + + + + +API: NexText.cpp Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexText.cpp
+
+
+Go to the documentation of this file.
1 
+
16 #include "NexText.h"
+
17 
+
22 NexText::NexText(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop, void *pop_ptr)
+
23  :NexTouch(pid, cid, name, pop, pop_ptr)
+
24 {
+
25 }
+
26 
+
35 uint16_t NexText::getText(char *buffer, uint16_t len)
+
36 {
+
37  String cmd;
+
38  cmd += "get ";
+
39  cmd += getObjName();
+
40  cmd += ".txt";
+
41  sendCommand(cmd.c_str());
+
42  return recvRetString(buffer,len);
+
43 }
+
44 
+
53 bool NexText::setText(const char *buffer)
+
54 {
+
55  String cmd;
+
56  cmd += getObjName();
+
57  cmd += ".txt=\"";
+
58  cmd += buffer;
+
59  cmd += "\"";
+
60  sendCommand(cmd.c_str());
+
61  return recvRetCommandFinished();
+
62 }
+
63 
+
70 void NexText::attachPop(NexTouchEventCb pop, void *ptr)
+
71 {
+
72  NexTouch::attachPop(pop, ptr);
+
73 }
+
74 
+ +
80 {
+
81  NexTouch::detachPop();
+
82 }
+
83 
+
bool setText(const char *buffer)
Set the value of text.
Definition: NexText.cpp:53
+
void detachPop(void)
Unload text pop callback function.
Definition: NexText.cpp:79
+
API of NexText.
+
static void sendCommand(const char *cmd)
Send command to Nextion.
Definition: NexTouch.cpp:261
+
const char * getObjName(void)
Get component name.
Definition: NexTouch.cpp:112
+
uint16_t getText(char *buffer, uint16_t len)
Get the value of text.
Definition: NexText.cpp:35
+
NexText(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)
Constructor,inherited NexTouch's constructor function.
Definition: NexText.cpp:22
+
static uint16_t recvRetString(char *buffer, uint16_t len, uint32_t timeout=500)
Receive string data.
Definition: NexTouch.cpp:284
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register text pop callback function.
Definition: NexText.cpp:70
+
static bool recvRetCommandFinished(uint32_t timeout=100)
Command is executed successfully.
Definition: NexTouch.cpp:224
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/_nex_text_8h.html b/doc/API-html/_nex_text_8h.html new file mode 100644 index 00000000..219ae5e --- /dev/null +++ b/doc/API-html/_nex_text_8h.html @@ -0,0 +1,83 @@ + + + + + + +API: NexText.h File Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Classes
+
+
NexText.h File Reference
+
+
+ +

API of NexText. +More...

+
#include "NexTouch.h"
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  NexText
 NexText,subclass of NexTouch,provides simple methods to control text component. More...
 
+

Detailed Description

+

API of NexText.

+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ + +

Definition in file NexText.h.

+
+ + + + diff --git a/doc/API-html/_nex_text_8h_source.html b/doc/API-html/_nex_text_8h_source.html new file mode 100644 index 00000000..99e7a2d --- /dev/null +++ b/doc/API-html/_nex_text_8h_source.html @@ -0,0 +1,88 @@ + + + + + + +API: NexText.h Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexText.h
+
+
+Go to the documentation of this file.
1 
+
16 #ifndef __NEXTEXT_H__
+
17 #define __NEXTEXT_H__
+
18 #ifdef __cplusplus
+
19 #include "NexTouch.h"
+
20 
+
25 class NexText: public NexTouch
+
26 {
+
27 public: /* methods */
+
28  NexText(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop = NULL, void *pop_ptr = NULL);
+
29 
+
30  void attachPop(NexTouchEventCb pop, void *ptr = NULL);
+
31  void detachPop(void);
+
32 
+
33  uint16_t getText(char *buffer, uint16_t len);
+
34  bool setText(const char *buffer);
+
35 };
+
36 
+
37 #endif /* #ifdef __cplusplus */
+
38 #endif /* #ifndef __NEXTEXT_H__ */
+
bool setText(const char *buffer)
Set the value of text.
Definition: NexText.cpp:53
+
void detachPop(void)
Unload text pop callback function.
Definition: NexText.cpp:79
+
uint16_t getText(char *buffer, uint16_t len)
Get the value of text.
Definition: NexText.cpp:35
+
API of Nextion.
+
NexText(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)
Constructor,inherited NexTouch's constructor function.
Definition: NexText.cpp:22
+
void attachPop(NexTouchEventCb pop, void *ptr=NULL)
Register text pop callback function.
Definition: NexText.cpp:70
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
NexText,subclass of NexTouch,provides simple methods to control text component.
Definition: NexText.h:25
+
+ + + + diff --git a/doc/API-html/_nex_touch_8cpp-example.html b/doc/API-html/_nex_touch_8cpp-example.html new file mode 100644 index 00000000..bb8e8c3 --- /dev/null +++ b/doc/API-html/_nex_touch_8cpp-example.html @@ -0,0 +1,59 @@ + + + + + + +API: NexTouch.cpp + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + +
+
+
+
NexTouch.cpp
+
+
+
Show how to use API of class NexButton.
+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ +
+ + + + diff --git a/doc/API-html/_nex_touch_8cpp.html b/doc/API-html/_nex_touch_8cpp.html new file mode 100644 index 00000000..56de0a3 --- /dev/null +++ b/doc/API-html/_nex_touch_8cpp.html @@ -0,0 +1,148 @@ + + + + + + +API: NexTouch.cpp File Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Functions
+
+
NexTouch.cpp File Reference
+
+
+ +

API of Nextion. +More...

+
#include "NexTouch.h"
+
+

Go to the source code of this file.

+ + + + + + + + +

+Functions

bool nexInit (void)
 Init Nextion's baudrate,page id. More...
 
bool nexLoop (NexTouch **nexListenList)
 Call mainEventLoop,watting for Nextion's touch event. More...
 
+

Detailed Description

+

API of Nextion.

+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ + +

Definition in file NexTouch.cpp.

+

Function Documentation

+ +
+
+ + + + + + + + +
bool nexInit (void )
+
+ +

Init Nextion's baudrate,page id.

+
Return values
+ + + +
true- success.
false- failed.
+
+
+
Examples:
CompHotspot.ino.
+
+

Definition at line 423 of file NexTouch.cpp.

+ +
+
+ +
+
+ + + + + + + + +
bool nexLoop (NexTouch ** nexListenList)
+
+ +

Call mainEventLoop,watting for Nextion's touch event.

+
Parameters
+ + +
nexListenList- index to Nextion Components list.
+
+
+
Return values
+ + +
false- failed.
+
+
+
Examples:
CompHotspot.ino.
+
+

Definition at line 440 of file NexTouch.cpp.

+ +
+
+
+ + + + diff --git a/doc/API-html/_nex_touch_8cpp_source.html b/doc/API-html/_nex_touch_8cpp_source.html new file mode 100644 index 00000000..fdfcb88 --- /dev/null +++ b/doc/API-html/_nex_touch_8cpp_source.html @@ -0,0 +1,421 @@ + + + + + + +API: NexTouch.cpp Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexTouch.cpp
+
+
+Go to the documentation of this file.
1 
+
16 #include "NexTouch.h"
+
17 
+
18 uint8_t NexTouch::__buffer[256] = {0};
+
19 
+ +
27 {
+
28  uint16_t i;
+
29  uint8_t c;
+
30 
+
31  while (true)
+
32  {
+
33  while (nexSerial.available() > 0)
+
34  {
+
35  delay(10);
+
36  c = nexSerial.read();
+
37 
+
38  if (NEX_RET_EVENT_TOUCH_HEAD == c)
+
39  {
+
40  if (nexSerial.available() >= 6)
+
41  {
+
42  //memset(__buffer, 0, sizeof(__buffer));
+
43  __buffer[0] = c;
+
44  for (i = 1; i < 7; i++)
+
45  {
+
46  __buffer[i] = nexSerial.read();
+
47  }
+
48  __buffer[i] = 0x00;
+
49 
+
50  if (0xFF == __buffer[4] && 0xFF == __buffer[5] && 0xFF == __buffer[6])
+
51  {
+
52  iterate(list, (NexPid)__buffer[1], (NexCid)__buffer[2], (NexEventType)__buffer[3]);
+
53  }
+
54 
+
55  }
+
56  }
+
57  }
+
58  }
+
59  return 0;
+
60 }
+
61 
+
74 NexTouch::NexTouch(NexPid pid, NexCid cid, char *name,
+
75  NexTouchEventCb pop, void *pop_ptr,
+
76  NexTouchEventCb push, void *push_ptr)
+
77 {
+
78  this->pid = pid;
+
79  this->cid = cid;
+
80  this->name = name;
+
81  this->cbPush = push;
+
82  this->cbPop = pop;
+
83  this->__cbpop_ptr = pop_ptr;
+
84  this->__cbpush_ptr = push_ptr;
+
85 }
+
86 
+
92 NexPid NexTouch::getPid(void)
+
93 {
+
94  return pid;
+
95 }
+
96 
+
102 NexCid NexTouch::getCid(void)
+
103 {
+
104  return cid;
+
105 }
+
106 
+
112 const char* NexTouch::getObjName(void)
+
113 {
+
114  return name;
+
115 }
+
116 
+
122 void NexTouch::print(void)
+
123 {
+
124  dbSerial.print("[");
+
125  dbSerial.print((uint32_t)this);
+
126  dbSerial.print(":");
+
127  dbSerial.print(pid);
+
128  dbSerial.print(",");
+
129  dbSerial.print(cid);
+
130  dbSerial.print(",");
+
131  if (name)
+
132  {
+
133  dbSerial.print(name);
+
134  }
+
135  else
+
136  {
+
137  dbSerial.print("(null)");
+
138  }
+
139  dbSerial.print(",");
+
140  dbSerial.print((uint32_t)cbPush);
+
141  dbSerial.print(",");
+
142  dbSerial.print((uint32_t)cbPop);
+
143  dbSerial.println("]");
+
144 }
+
145 
+
146 void NexTouch::attachPush(NexTouchEventCb push, void *ptr)
+
147 {
+
148  this->cbPush = push;
+
149  this->__cbpush_ptr = ptr;
+
150 }
+
151 
+
152 void NexTouch::detachPush(void)
+
153 {
+
154  this->cbPush = NULL;
+
155  this->__cbpush_ptr = NULL;
+
156 }
+
157 
+
158 void NexTouch::attachPop(NexTouchEventCb pop, void *ptr)
+
159 {
+
160  this->cbPop = pop;
+
161  this->__cbpop_ptr = ptr;
+
162 }
+
163 
+
164 void NexTouch::detachPop(void)
+
165 {
+
166  this->cbPop = NULL;
+
167  this->__cbpop_ptr = NULL;
+
168 }
+
169 
+
170 void NexTouch::iterate(NexTouch **list, NexPid pid, NexCid cid, NexEventType event)
+
171 {
+
172  NexTouch *e = NULL;
+
173  uint16_t i = 0;
+
174 
+
175  if (NULL == list)
+
176  {
+
177  return;
+
178  }
+
179 
+
180  for(i = 0; (e = list[i]) != NULL; i++)
+
181  {
+
182  if (e->getPid() == pid && e->getCid() == cid)
+
183  {
+
184  e->print();
+
185  if (NEX_EVENT_PUSH == event)
+
186  {
+
187  e->push();
+
188  }
+
189  else if (NEX_EVENT_POP == event)
+
190  {
+
191  e->pop();
+
192  }
+
193 
+
194  break;
+
195  }
+
196  }
+
197 }
+
198 
+
199 void NexTouch::push(void)
+
200 {
+
201  if (cbPush)
+
202  {
+
203  cbPush(__cbpush_ptr);
+
204  }
+
205 }
+
206 
+
207 void NexTouch::pop(void)
+
208 {
+
209  if (cbPop)
+
210  {
+
211  cbPop(__cbpop_ptr);
+
212  }
+
213 }
+
214 
+
224 bool NexTouch::recvRetCommandFinished(uint32_t timeout)
+
225 {
+
226  bool ret = false;
+
227  uint8_t temp[4] = {0};
+
228 
+
229  nexSerial.setTimeout(timeout);
+
230  if (sizeof(temp) != nexSerial.readBytes((char *)temp, sizeof(temp)))
+
231  {
+
232  ret = false;
+
233  }
+
234 
+
235  if (temp[0] == NEX_RET_CMD_FINISHED
+
236  && temp[1] == 0xFF
+
237  && temp[2] == 0xFF
+
238  && temp[3] == 0xFF
+
239  )
+
240  {
+
241  ret = true;
+
242  }
+
243 
+
244  if (ret)
+
245  {
+
246  dbSerial.println("recvRetCommandFinished ok");
+
247  }
+
248  else
+
249  {
+
250  dbSerial.println("recvRetCommandFinished err");
+
251  }
+
252 
+
253  return ret;
+
254 }
+
255 
+
261 void NexTouch::sendCommand(const char* cmd)
+
262 {
+
263  while (nexSerial.available())
+
264  {
+
265  nexSerial.read();
+
266  }
+
267 
+
268  nexSerial.print(cmd);
+
269  nexSerial.write(0xFF);
+
270  nexSerial.write(0xFF);
+
271  nexSerial.write(0xFF);
+
272 }
+
273 
+
284 uint16_t NexTouch::recvRetString(char *buffer, uint16_t len, uint32_t timeout)
+
285 {
+
286  uint16_t ret = 0;
+
287  bool str_start_flag = false;
+
288  uint8_t cnt_0xff = 0;
+
289  String temp = String("");
+
290  uint8_t c = 0;
+
291  long start;
+
292 
+
293  if (!buffer || len == 0)
+
294  {
+
295  goto __return;
+
296  }
+
297 
+
298  start = millis();
+
299  while (millis() - start <= timeout)
+
300  {
+
301  while (nexSerial.available())
+
302  {
+
303  c = nexSerial.read();
+
304  if (str_start_flag)
+
305  {
+
306  if (0xFF == c)
+
307  {
+
308  cnt_0xff++;
+
309  if (cnt_0xff >= 3)
+
310  {
+
311  break;
+
312  }
+
313  }
+
314  else
+
315  {
+
316  temp += (char)c;
+
317  }
+
318  }
+
319  else if (NEX_RET_STRING_HEAD == c)
+
320  {
+
321  str_start_flag = true;
+
322  }
+
323  }
+
324 
+
325  if (cnt_0xff >= 3)
+
326  {
+
327  break;
+
328  }
+
329  }
+
330 
+
331  ret = temp.length();
+
332  ret = ret > len ? len : ret;
+
333  strncpy(buffer, temp.c_str(), ret);
+
334 
+
335 __return:
+
336 
+
337  dbSerial.print("recvRetString[");
+
338  dbSerial.print(temp.length());
+
339  dbSerial.print(",");
+
340  dbSerial.print(temp);
+
341  dbSerial.println("]");
+
342 
+
343  return ret;
+
344 }
+
345 
+
356 bool NexTouch::recvRetNumber(uint32_t *number, uint32_t timeout)
+
357 {
+
358  bool ret = false;
+
359  uint8_t temp[8] = {0};
+
360 
+
361  if (!number)
+
362  {
+
363  goto __return;
+
364  }
+
365 
+
366  nexSerial.setTimeout(timeout);
+
367  if (sizeof(temp) != nexSerial.readBytes((char *)temp, sizeof(temp)))
+
368  {
+
369  goto __return;
+
370  }
+
371 
+
372  if (temp[0] == NEX_RET_NUMBER_HEAD
+
373  && temp[5] == 0xFF
+
374  && temp[6] == 0xFF
+
375  && temp[7] == 0xFF
+
376  )
+
377  {
+
378  *number = (temp[4] << 24) | (temp[3] << 16) | (temp[2] << 8) | (temp[1]);
+
379  ret = true;
+
380  }
+
381 
+
382 __return:
+
383 
+
384  if (ret)
+
385  {
+
386  dbSerial.print("recvRetNumber :");
+
387  dbSerial.println(*number);
+
388  }
+
389  else
+
390  {
+
391  dbSerial.println("recvRetNumber err");
+
392  }
+
393 
+
394  return ret;
+
395 }
+
396 
+
397 bool NexTouch::setBrightness(uint32_t brightness)
+
398 {
+
399  char buf[10] = {0};
+
400  String cmd;
+
401 
+
402  utoa(brightness, buf, 10);
+
403  cmd += "dim=";
+
404  cmd += buf;
+
405 
+
406  sendCommand(cmd.c_str());
+
407  return recvRetCommandFinished();
+
408 }
+
409 
+
410 bool NexTouch::getBrightness(uint32_t *brightness)
+
411 {
+
412  sendCommand("get dim");
+
413  return recvRetNumber(brightness);
+
414 }
+
415 
+
416 
+
423 bool nexInit(void)
+
424 {
+
425  nexSerial.begin(9600);
+ +
427  NexTouch::sendCommand("page 0");
+
428  delay(100);
+
429  return true;
+
430 }
+
431 
+
432 
+
440 bool nexLoop(NexTouch **nexListenList)
+
441 {
+
442  NexTouch::mainEventLoop(nexListenList);
+
443  return false;
+
444 }
+
445 
+
446 
+
NexPid getPid(void)
Get page id.
Definition: NexTouch.cpp:92
+
NexTouch(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)
Constructor of Nextouch.
Definition: NexTouch.cpp:74
+
bool nexInit(void)
Init Nextion's baudrate,page id.
Definition: NexTouch.cpp:423
+
bool nexLoop(NexTouch **nexListenList)
Call mainEventLoop,watting for Nextion's touch event.
Definition: NexTouch.cpp:440
+
static void sendCommand(const char *cmd)
Send command to Nextion.
Definition: NexTouch.cpp:261
+
const char * getObjName(void)
Get component name.
Definition: NexTouch.cpp:112
+
void print(void)
Print current object address,page id,component id, component name,pop event function address...
Definition: NexTouch.cpp:122
+
static uint8_t mainEventLoop(NexTouch **list)
Watting for Nextion's touch event.
Definition: NexTouch.cpp:26
+
NexCid getCid(void)
Get component id.
Definition: NexTouch.cpp:102
+
API of Nextion.
+
static bool recvRetNumber(uint32_t *number, uint32_t timeout=500)
Receive uint32_t data.
Definition: NexTouch.cpp:356
+
static uint16_t recvRetString(char *buffer, uint16_t len, uint32_t timeout=500)
Receive string data.
Definition: NexTouch.cpp:284
+
static bool recvRetCommandFinished(uint32_t timeout=100)
Command is executed successfully.
Definition: NexTouch.cpp:224
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/_nex_touch_8h.html b/doc/API-html/_nex_touch_8h.html new file mode 100644 index 00000000..be48913 --- /dev/null +++ b/doc/API-html/_nex_touch_8h.html @@ -0,0 +1,153 @@ + + + + + + +API: NexTouch.h File Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Classes | +Functions
+
+
NexTouch.h File Reference
+
+
+ +

API of Nextion. +More...

+
#include <Arduino.h>
+
+

Go to the source code of this file.

+ + + + + +

+Classes

class  NexTouch
 Root Class of Nextion Components. More...
 
+ + + + + + + +

+Functions

bool nexInit (void)
 Init Nextion's baudrate,page id. More...
 
bool nexLoop (NexTouch **nexListenList)
 Call mainEventLoop,watting for Nextion's touch event. More...
 
+

Detailed Description

+

API of Nextion.

+
Author
Wu Pengfei (email:pengf.nosp@m.ei.w.nosp@m.u@ite.nosp@m.ad.c.nosp@m.c)
+
Date
2015/7/10
+ + +

Definition in file NexTouch.h.

+

Function Documentation

+ +
+
+ + + + + + + + +
bool nexInit (void )
+
+ +

Init Nextion's baudrate,page id.

+
Return values
+ + + +
true- success.
false- failed.
+
+
+ +

Definition at line 423 of file NexTouch.cpp.

+ +
+
+ +
+
+ + + + + + + + +
bool nexLoop (NexTouch ** nexListenList)
+
+ +

Call mainEventLoop,watting for Nextion's touch event.

+
Parameters
+ + +
nexListenList- index to Nextion Components list.
+
+
+
Return values
+ + +
false- failed.
+
+
+ +

Definition at line 440 of file NexTouch.cpp.

+ +
+
+
+ + + + diff --git a/doc/API-html/_nex_touch_8h_source.html b/doc/API-html/_nex_touch_8h_source.html new file mode 100644 index 00000000..0384d51 --- /dev/null +++ b/doc/API-html/_nex_touch_8h_source.html @@ -0,0 +1,171 @@ + + + + + + +API: NexTouch.h Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexTouch.h
+
+
+Go to the documentation of this file.
1 
+
16 #ifndef __NEXTOUCH_H__
+
17 #define __NEXTOUCH_H__
+
18 #ifdef __cplusplus
+
19 #include <Arduino.h>
+
20 
+
21 
+
22 /*Define debug serial*/
+
23 #define dbSerial Serial
+
24 
+
25 /*Define Nextion serial*/
+
26 #define nexSerial Serial2
+
27 
+
28 typedef uint8_t NexPid;
+
29 typedef uint8_t NexCid;
+
30 
+
31 typedef enum {
+
32  NEX_EVENT_POP = 0x00,
+
33  NEX_EVENT_PUSH = 0x01,
+
34  NEX_EVENT_NULL
+
35 } NexEventType;
+
36 
+
37 /*The first byte of Nextoin's return value*/
+
38 #define NEX_RET_CMD_FINISHED (0x01)
+
39 #define NEX_RET_EVENT_LAUNCHED (0x88)
+
40 #define NEX_RET_EVENT_UPGRADED (0x89)
+
41 #define NEX_RET_EVENT_TOUCH_HEAD (0x65)
+
42 #define NEX_RET_EVENT_POSITION_HEAD (0x67)
+
43 #define NEX_RET_EVENT_SLEEP_POSITION_HEAD (0x68)
+
44 #define NEX_RET_CURRENT_PAGE_ID_HEAD (0x66)
+
45 #define NEX_RET_STRING_HEAD (0x70)
+
46 #define NEX_RET_NUMBER_HEAD (0x71)
+
47 #define NEX_RET_INVALID_CMD (0x00)
+
48 #define NEX_RET_INVALID_COMPONENT_ID (0x02)
+
49 #define NEX_RET_INVALID_PAGE_ID (0x03)
+
50 #define NEX_RET_INVALID_PICTURE_ID (0x04)
+
51 #define NEX_RET_INVALID_FONT_ID (0x05)
+
52 #define NEX_RET_INVALID_BAUD (0x11)
+
53 #define NEX_RET_INVALID_VARIABLE (0x1A)
+
54 #define NEX_RET_INVALID_OPERATION (0x1B)
+
55 
+
56 
+
57 typedef void (*NexTouchEventCb)(void *ptr);
+
58 
+
63 class NexTouch
+
64 {
+
65 public: /* static methods */
+
66  static uint8_t mainEventLoop(NexTouch **list);
+
67  static void sendCommand(const char *cmd);
+
68  static bool recvRetCommandFinished(uint32_t timeout = 100);
+
69  static uint16_t recvRetString(char *buffer, uint16_t len, uint32_t timeout = 500);
+
70  static bool recvRetNumber(uint32_t *number, uint32_t timeout = 500);
+
71 
+
72 public: /* methods */
+
73  NexTouch(NexPid pid, NexCid cid, char *name,
+
74  NexTouchEventCb pop = NULL, void *pop_ptr = NULL,
+
75  NexTouchEventCb push = NULL, void *push_ptr = NULL);
+
76 
+
77  NexPid getPid(void);
+
78  NexCid getCid(void);
+
79  const char *getObjName(void);
+
80  void print(void);
+
81 
+
82 protected: /* static methods */
+
83  static bool setBrightness(uint32_t brightness);
+
84  static bool getBrightness(uint32_t *brightness);
+
85 
+
86 protected: /* methods */
+
87  void attachPush(NexTouchEventCb push, void *ptr = NULL);
+
88  void detachPush(void);
+
89  void attachPop(NexTouchEventCb pop, void *ptr = NULL);
+
90  void detachPop(void);
+
91 
+
92 private: /* static methods */
+
93  static void iterate(NexTouch **list, NexPid pid, NexCid cid, NexEventType event);
+
94 
+
95 private: /* methods */
+
96  void push(void);
+
97  void pop(void);
+
98 
+
99 private: /* static data */
+
100  static uint8_t __buffer[256];
+
101 
+
102 private: /* data */
+
103  NexPid pid; /* Page ID */
+
104  NexCid cid; /* Component ID */
+
105  char *name; /* An unique name */
+
106  NexTouchEventCb cbPush;
+
107  void *__cbpush_ptr;
+
108  NexTouchEventCb cbPop;
+
109  void *__cbpop_ptr;
+
110 };
+
111 
+
112 bool nexInit(void);
+
113 bool nexLoop(NexTouch **nexListenList);
+
114 
+
115 #endif /* #ifdef __cplusplus */
+
116 #endif /* #ifndef __NEXTOUCH_H__ */
+
NexPid getPid(void)
Get page id.
Definition: NexTouch.cpp:92
+
NexTouch(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)
Constructor of Nextouch.
Definition: NexTouch.cpp:74
+
bool nexInit(void)
Init Nextion's baudrate,page id.
Definition: NexTouch.cpp:423
+
static void sendCommand(const char *cmd)
Send command to Nextion.
Definition: NexTouch.cpp:261
+
const char * getObjName(void)
Get component name.
Definition: NexTouch.cpp:112
+
void print(void)
Print current object address,page id,component id, component name,pop event function address...
Definition: NexTouch.cpp:122
+
static uint8_t mainEventLoop(NexTouch **list)
Watting for Nextion's touch event.
Definition: NexTouch.cpp:26
+
NexCid getCid(void)
Get component id.
Definition: NexTouch.cpp:102
+
bool nexLoop(NexTouch **nexListenList)
Call mainEventLoop,watting for Nextion's touch event.
Definition: NexTouch.cpp:440
+
static bool recvRetNumber(uint32_t *number, uint32_t timeout=500)
Receive uint32_t data.
Definition: NexTouch.cpp:356
+
static uint16_t recvRetString(char *buffer, uint16_t len, uint32_t timeout=500)
Receive string data.
Definition: NexTouch.cpp:284
+
static bool recvRetCommandFinished(uint32_t timeout=100)
Command is executed successfully.
Definition: NexTouch.cpp:224
+
Root Class of Nextion Components.
Definition: NexTouch.h:63
+
+ + + + diff --git a/doc/API-html/annotated.html b/doc/API-html/annotated.html new file mode 100644 index 00000000..3236e8e --- /dev/null +++ b/doc/API-html/annotated.html @@ -0,0 +1,75 @@ + + + + + + +API: Class List + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
Class List
+
+
+
Here are the classes, structs, unions and interfaces with brief descriptions:
+ + + + + + + + + + +
 CNexButtonNexButton,subclass of NexTouch,provides simple methods to control button component
 CNexHotspotNexHotspot,subclass of NexTouch,provides simple methods to control hotspot component
 CNexPageNexPage,subclass of NexTouch,provides simple methods to control page component
 CNexPictureNexPicture,subclass of NexTouch,provides simple methods to control picture component
 CNexPointerNexPointer,subclass of NexTouch,provides simple methods to control pointer component
 CNexProgressBarNexProgressBar,subclass of NexTouch,provides simple methods to control progress bar component
 CNexSliceNexSlice,subclass of NexTouch,provides simple methods to control slice component
 CNexTextNexText,subclass of NexTouch,provides simple methods to control text component
 CNexTouchRoot Class of Nextion Components
+
+
+ + + + diff --git a/doc/API-html/bc_s.png b/doc/API-html/bc_s.png new file mode 100644 index 00000000..d0d0e79 Binary files /dev/null and b/doc/API-html/bc_s.png differ diff --git a/doc/API-html/bdwn.png b/doc/API-html/bdwn.png new file mode 100644 index 00000000..9e47d9a Binary files /dev/null and b/doc/API-html/bdwn.png differ diff --git a/doc/API-html/class_nex_button-members.html b/doc/API-html/class_nex_button-members.html new file mode 100644 index 00000000..ab26653 --- /dev/null +++ b/doc/API-html/class_nex_button-members.html @@ -0,0 +1,80 @@ + + + + + + +API: Member List + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexButton Member List
+
+
+ +

This is the complete list of members for NexButton, including all inherited members.

+ + + + + + + + + + + + + + + + +
attachPop(NexTouchEventCb pop, void *ptr=NULL)NexButton
detachPop(void)NexButton
getCid(void)NexTouch
getObjName(void)NexTouch
getPid(void)NexTouch
getText(char *buffer, uint16_t len)NexButton
mainEventLoop(NexTouch **list)NexTouchstatic
NexButton(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)NexButton
NexTouch(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)NexTouch
print(void)NexTouch
recvRetCommandFinished(uint32_t timeout=100)NexTouchstatic
recvRetNumber(uint32_t *number, uint32_t timeout=500)NexTouchstatic
recvRetString(char *buffer, uint16_t len, uint32_t timeout=500)NexTouchstatic
sendCommand(const char *cmd)NexTouchstatic
setText(const char *buffer)NexButton
+ + + + diff --git a/doc/API-html/class_nex_button.html b/doc/API-html/class_nex_button.html new file mode 100644 index 00000000..0ed0c58 --- /dev/null +++ b/doc/API-html/class_nex_button.html @@ -0,0 +1,253 @@ + + + + + + +API: NexButton Class Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Public Member Functions | +List of all members
+
+
NexButton Class Reference
+
+
+ +

NexButton,subclass of NexTouch,provides simple methods to control button component. + More...

+ +

#include <NexButton.h>

+
+Inheritance diagram for NexButton:
+
+
+ + +NexTouch + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

NexButton (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)
 Constructor,inherited NexTouch's constructor function.
 
void attachPop (NexTouchEventCb pop, void *ptr=NULL)
 Register button pop callback function. More...
 
+void detachPop (void)
 Unload button pop callback function.
 
uint16_t getText (char *buffer, uint16_t len)
 Get text value from button component. More...
 
bool setText (const char *buffer)
 Set text value of button component. More...
 
- Public Member Functions inherited from NexTouch
 NexTouch (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)
 Constructor of Nextouch. More...
 
NexPid getPid (void)
 Get page id. More...
 
NexCid getCid (void)
 Get component id. More...
 
const char * getObjName (void)
 Get component name. More...
 
+void print (void)
 Print current object address,page id,component id, component name,pop event function address,push event function address.
 
+ + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from NexTouch
static uint8_t mainEventLoop (NexTouch **list)
 Watting for Nextion's touch event. More...
 
static void sendCommand (const char *cmd)
 Send command to Nextion. More...
 
static bool recvRetCommandFinished (uint32_t timeout=100)
 Command is executed successfully. More...
 
static uint16_t recvRetString (char *buffer, uint16_t len, uint32_t timeout=500)
 Receive string data. More...
 
static bool recvRetNumber (uint32_t *number, uint32_t timeout=500)
 Receive uint32_t data. More...
 
+

Detailed Description

+

NexButton,subclass of NexTouch,provides simple methods to control button component.

+ +

Definition at line 25 of file NexButton.h.

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
void NexButton::attachPop (NexTouchEventCb pop,
void * ptr = NULL 
)
+
+ +

Register button pop callback function.

+
Parameters
+ + + +
pop- the pointer to button pop callback function.
ptr- the parameter to be transmitted to button pop callback function.
+
+
+ +

Definition at line 70 of file NexButton.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
uint16_t NexButton::getText (char * buffer,
uint16_t len 
)
+
+ +

Get text value from button component.

+
Parameters
+ + + +
buffer- text buffer.
len- text buffer length.
+
+
+
Returns
the text buffer length
+ +

Definition at line 35 of file NexButton.cpp.

+ +
+
+ +
+
+ + + + + + + + +
bool NexButton::setText (const char * buffer)
+
+ +

Set text value of button component.

+
Parameters
+ + +
buffer- text buffer.
+
+
+
Return values
+ + + +
true- success.
false- failed.
+
+
+ +

Definition at line 53 of file NexButton.cpp.

+ +
+
+
The documentation for this class was generated from the following files: +
+ + + + diff --git a/doc/API-html/class_nex_button.png b/doc/API-html/class_nex_button.png new file mode 100644 index 00000000..0cd1db0 Binary files /dev/null and b/doc/API-html/class_nex_button.png differ diff --git a/doc/API-html/class_nex_hotspot-members.html b/doc/API-html/class_nex_hotspot-members.html new file mode 100644 index 00000000..4d1d93a --- /dev/null +++ b/doc/API-html/class_nex_hotspot-members.html @@ -0,0 +1,80 @@ + + + + + + +API: Member List + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexHotspot Member List
+
+
+ +

This is the complete list of members for NexHotspot, including all inherited members.

+ + + + + + + + + + + + + + + + +
attachPop(NexTouchEventCb pop, void *ptr=NULL)NexHotspot
attachPush(NexTouchEventCb push, void *ptr=NULL)NexHotspot
detachPop(void)NexHotspot
detachPush(void)NexHotspot
getCid(void)NexTouch
getObjName(void)NexTouch
getPid(void)NexTouch
mainEventLoop(NexTouch **list)NexTouchstatic
NexHotspot(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)NexHotspot
NexTouch(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)NexTouch
print(void)NexTouch
recvRetCommandFinished(uint32_t timeout=100)NexTouchstatic
recvRetNumber(uint32_t *number, uint32_t timeout=500)NexTouchstatic
recvRetString(char *buffer, uint16_t len, uint32_t timeout=500)NexTouchstatic
sendCommand(const char *cmd)NexTouchstatic
+ + + + diff --git a/doc/API-html/class_nex_hotspot.html b/doc/API-html/class_nex_hotspot.html new file mode 100644 index 00000000..5d58774 --- /dev/null +++ b/doc/API-html/class_nex_hotspot.html @@ -0,0 +1,223 @@ + + + + + + +API: NexHotspot Class Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Public Member Functions | +List of all members
+
+
NexHotspot Class Reference
+
+
+ +

NexHotspot,subclass of NexTouch,provides simple methods to control hotspot component. + More...

+ +

#include <NexHotspot.h>

+
+Inheritance diagram for NexHotspot:
+
+
+ + +NexTouch + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

NexHotspot (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)
 Constructor,inherited NexTouch's constructor function.
 
void attachPush (NexTouchEventCb push, void *ptr=NULL)
 Register hotspot push callback function. More...
 
+void detachPush (void)
 Unload hotsopt push callback function.
 
void attachPop (NexTouchEventCb pop, void *ptr=NULL)
 Register hotspot pop callback function. More...
 
+void detachPop (void)
 Unload hotsopt pop callback function.
 
- Public Member Functions inherited from NexTouch
 NexTouch (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)
 Constructor of Nextouch. More...
 
NexPid getPid (void)
 Get page id. More...
 
NexCid getCid (void)
 Get component id. More...
 
const char * getObjName (void)
 Get component name. More...
 
+void print (void)
 Print current object address,page id,component id, component name,pop event function address,push event function address.
 
+ + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from NexTouch
static uint8_t mainEventLoop (NexTouch **list)
 Watting for Nextion's touch event. More...
 
static void sendCommand (const char *cmd)
 Send command to Nextion. More...
 
static bool recvRetCommandFinished (uint32_t timeout=100)
 Command is executed successfully. More...
 
static uint16_t recvRetString (char *buffer, uint16_t len, uint32_t timeout=500)
 Receive string data. More...
 
static bool recvRetNumber (uint32_t *number, uint32_t timeout=500)
 Receive uint32_t data. More...
 
+

Detailed Description

+

NexHotspot,subclass of NexTouch,provides simple methods to control hotspot component.

+
Examples:
CompHotspot.ino.
+
+

Definition at line 25 of file NexHotspot.h.

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
void NexHotspot::attachPop (NexTouchEventCb pop,
void * ptr = NULL 
)
+
+ +

Register hotspot pop callback function.

+
Parameters
+ + + +
pop- the pointer to hotspot pot callback function.
ptr- the parameter to be transmitted to hotspot pop callback function.
+
+
+
Examples:
CompHotspot.ino.
+
+

Definition at line 55 of file NexHotspot.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void NexHotspot::attachPush (NexTouchEventCb push,
void * ptr = NULL 
)
+
+ +

Register hotspot push callback function.

+
Parameters
+ + + +
pop- the pointer to hotspot push callback function.
ptr- the parameter to be transmitted to hotspot push callback function.
+
+
+
Examples:
CompHotspot.ino.
+
+

Definition at line 35 of file NexHotspot.cpp.

+ +
+
+
The documentation for this class was generated from the following files: +
+ + + + diff --git a/doc/API-html/class_nex_hotspot.png b/doc/API-html/class_nex_hotspot.png new file mode 100644 index 00000000..df0d708 Binary files /dev/null and b/doc/API-html/class_nex_hotspot.png differ diff --git a/doc/API-html/class_nex_page-members.html b/doc/API-html/class_nex_page-members.html new file mode 100644 index 00000000..1e59b75 --- /dev/null +++ b/doc/API-html/class_nex_page-members.html @@ -0,0 +1,79 @@ + + + + + + +API: Member List + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexPage Member List
+
+
+ +

This is the complete list of members for NexPage, including all inherited members.

+ + + + + + + + + + + + + + + +
attachPop(NexTouchEventCb pop, void *ptr=NULL)NexPage
detachPop(void)NexPage
getCid(void)NexTouch
getObjName(void)NexTouch
getPid(void)NexTouch
mainEventLoop(NexTouch **list)NexTouchstatic
NexPage(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)NexPage
NexTouch(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)NexTouch
print(void)NexTouch
recvRetCommandFinished(uint32_t timeout=100)NexTouchstatic
recvRetNumber(uint32_t *number, uint32_t timeout=500)NexTouchstatic
recvRetString(char *buffer, uint16_t len, uint32_t timeout=500)NexTouchstatic
sendCommand(const char *cmd)NexTouchstatic
show(void)NexPage
+ + + + diff --git a/doc/API-html/class_nex_page.html b/doc/API-html/class_nex_page.html new file mode 100644 index 00000000..ce5041c --- /dev/null +++ b/doc/API-html/class_nex_page.html @@ -0,0 +1,206 @@ + + + + + + +API: NexPage Class Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Public Member Functions | +List of all members
+
+
NexPage Class Reference
+
+
+ +

NexPage,subclass of NexTouch,provides simple methods to control page component. + More...

+ +

#include <NexPage.h>

+
+Inheritance diagram for NexPage:
+
+
+ + +NexTouch + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

NexPage (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)
 Constructor,inherited NexTouch's constructor function.
 
bool show (void)
 Change page. More...
 
void attachPop (NexTouchEventCb pop, void *ptr=NULL)
 Register page pop callback function. More...
 
+void detachPop (void)
 Unload page pop callback function.
 
- Public Member Functions inherited from NexTouch
 NexTouch (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)
 Constructor of Nextouch. More...
 
NexPid getPid (void)
 Get page id. More...
 
NexCid getCid (void)
 Get component id. More...
 
const char * getObjName (void)
 Get component name. More...
 
+void print (void)
 Print current object address,page id,component id, component name,pop event function address,push event function address.
 
+ + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from NexTouch
static uint8_t mainEventLoop (NexTouch **list)
 Watting for Nextion's touch event. More...
 
static void sendCommand (const char *cmd)
 Send command to Nextion. More...
 
static bool recvRetCommandFinished (uint32_t timeout=100)
 Command is executed successfully. More...
 
static uint16_t recvRetString (char *buffer, uint16_t len, uint32_t timeout=500)
 Receive string data. More...
 
static bool recvRetNumber (uint32_t *number, uint32_t timeout=500)
 Receive uint32_t data. More...
 
+

Detailed Description

+

NexPage,subclass of NexTouch,provides simple methods to control page component.

+ +

Definition at line 25 of file NexPage.h.

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
void NexPage::attachPop (NexTouchEventCb pop,
void * ptr = NULL 
)
+
+ +

Register page pop callback function.

+
Parameters
+ + + +
pop- the pointer to page pop callback function.
ptr- the parameter to be transmitted to page pop callback function.
+
+
+ +

Definition at line 55 of file NexPage.cpp.

+ +
+
+ +
+
+ + + + + + + + +
bool NexPage::show (void )
+
+ +

Change page.

+
Return values
+ + + +
true- success.
false- failed.
+
+
+ +

Definition at line 33 of file NexPage.cpp.

+ +
+
+
The documentation for this class was generated from the following files: +
+ + + + diff --git a/doc/API-html/class_nex_page.png b/doc/API-html/class_nex_page.png new file mode 100644 index 00000000..f9d710e Binary files /dev/null and b/doc/API-html/class_nex_page.png differ diff --git a/doc/API-html/class_nex_picture-members.html b/doc/API-html/class_nex_picture-members.html new file mode 100644 index 00000000..e5eb446 --- /dev/null +++ b/doc/API-html/class_nex_picture-members.html @@ -0,0 +1,80 @@ + + + + + + +API: Member List + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexPicture Member List
+
+
+ +

This is the complete list of members for NexPicture, including all inherited members.

+ + + + + + + + + + + + + + + + +
attachPop(NexTouchEventCb pop, void *ptr=NULL)NexPicture
detachPop(void)NexPicture
getCid(void)NexTouch
getObjName(void)NexTouch
getPic(uint32_t *number)NexPicture
getPid(void)NexTouch
mainEventLoop(NexTouch **list)NexTouchstatic
NexPicture(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)NexPicture
NexTouch(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)NexTouch
print(void)NexTouch
recvRetCommandFinished(uint32_t timeout=100)NexTouchstatic
recvRetNumber(uint32_t *number, uint32_t timeout=500)NexTouchstatic
recvRetString(char *buffer, uint16_t len, uint32_t timeout=500)NexTouchstatic
sendCommand(const char *cmd)NexTouchstatic
setPic(uint32_t number)NexPicture
+ + + + diff --git a/doc/API-html/class_nex_picture.html b/doc/API-html/class_nex_picture.html new file mode 100644 index 00000000..b066c7f --- /dev/null +++ b/doc/API-html/class_nex_picture.html @@ -0,0 +1,247 @@ + + + + + + +API: NexPicture Class Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Public Member Functions | +List of all members
+
+
NexPicture Class Reference
+
+
+ +

NexPicture,subclass of NexTouch,provides simple methods to control picture component. + More...

+ +

#include <NexPicture.h>

+
+Inheritance diagram for NexPicture:
+
+
+ + +NexTouch + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

NexPicture (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)
 Constructor,inherited NexTouch's constructor function.
 
void attachPop (NexTouchEventCb pop, void *ptr=NULL)
 Register picture pop callback function. More...
 
+void detachPop (void)
 Unload picture pop callback function.
 
bool getPic (uint32_t *number)
 Get picture's number. More...
 
bool setPic (uint32_t number)
 Set picture's number. More...
 
- Public Member Functions inherited from NexTouch
 NexTouch (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)
 Constructor of Nextouch. More...
 
NexPid getPid (void)
 Get page id. More...
 
NexCid getCid (void)
 Get component id. More...
 
const char * getObjName (void)
 Get component name. More...
 
+void print (void)
 Print current object address,page id,component id, component name,pop event function address,push event function address.
 
+ + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from NexTouch
static uint8_t mainEventLoop (NexTouch **list)
 Watting for Nextion's touch event. More...
 
static void sendCommand (const char *cmd)
 Send command to Nextion. More...
 
static bool recvRetCommandFinished (uint32_t timeout=100)
 Command is executed successfully. More...
 
static uint16_t recvRetString (char *buffer, uint16_t len, uint32_t timeout=500)
 Receive string data. More...
 
static bool recvRetNumber (uint32_t *number, uint32_t timeout=500)
 Receive uint32_t data. More...
 
+

Detailed Description

+

NexPicture,subclass of NexTouch,provides simple methods to control picture component.

+ +

Definition at line 25 of file NexPicture.h.

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
void NexPicture::attachPop (NexTouchEventCb pop,
void * ptr = NULL 
)
+
+ +

Register picture pop callback function.

+
Parameters
+ + + +
pop- the pointer to picture pop callback function.
ptr- the parameter to be transmitted to picture pop callback function.
+
+
+ +

Definition at line 72 of file NexPicture.cpp.

+ +
+
+ +
+
+ + + + + + + + +
bool NexPicture::getPic (uint32_t * number)
+
+ +

Get picture's number.

+
Parameters
+ + +
number- an output parameter to save picture number.
+
+
+

true - success.

Return values
+ + +
false- failed.
+
+
+ +

Definition at line 35 of file NexPicture.cpp.

+ +
+
+ +
+
+ + + + + + + + +
bool NexPicture::setPic (uint32_t number)
+
+ +

Set picture's number.

+
Parameters
+ + +
number-the picture number.
+
+
+
Return values
+ + + +
true- success.
false- failed.
+
+
+ +

Definition at line 52 of file NexPicture.cpp.

+ +
+
+
The documentation for this class was generated from the following files: +
+ + + + diff --git a/doc/API-html/class_nex_picture.png b/doc/API-html/class_nex_picture.png new file mode 100644 index 00000000..b68679e Binary files /dev/null and b/doc/API-html/class_nex_picture.png differ diff --git a/doc/API-html/class_nex_pointer-members.html b/doc/API-html/class_nex_pointer-members.html new file mode 100644 index 00000000..afebed7 --- /dev/null +++ b/doc/API-html/class_nex_pointer-members.html @@ -0,0 +1,78 @@ + + + + + + +API: Member List + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexPointer Member List
+
+
+ +

This is the complete list of members for NexPointer, including all inherited members.

+ + + + + + + + + + + + + + +
getCid(void)NexTouch
getObjName(void)NexTouch
getPid(void)NexTouch
getValue(uint32_t *number)NexPointer
mainEventLoop(NexTouch **list)NexTouchstatic
NexPointer(NexPid pid, NexCid cid, char *name)NexPointer
NexTouch(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)NexTouch
print(void)NexTouch
recvRetCommandFinished(uint32_t timeout=100)NexTouchstatic
recvRetNumber(uint32_t *number, uint32_t timeout=500)NexTouchstatic
recvRetString(char *buffer, uint16_t len, uint32_t timeout=500)NexTouchstatic
sendCommand(const char *cmd)NexTouchstatic
setValue(uint32_t number)NexPointer
+ + + + diff --git a/doc/API-html/class_nex_pointer.html b/doc/API-html/class_nex_pointer.html new file mode 100644 index 00000000..5718970 --- /dev/null +++ b/doc/API-html/class_nex_pointer.html @@ -0,0 +1,204 @@ + + + + + + +API: NexPointer Class Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Public Member Functions | +List of all members
+
+
NexPointer Class Reference
+
+
+ +

NexPointer,subclass of NexTouch,provides simple methods to control pointer component. + More...

+ +

#include <NexPointer.h>

+
+Inheritance diagram for NexPointer:
+
+
+ + +NexTouch + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

NexPointer (NexPid pid, NexCid cid, char *name)
 Constructor,inherited NexTouch's constructor function.
 
bool getValue (uint32_t *number)
 Get the value of pointer. More...
 
bool setValue (uint32_t number)
 Set the value of pointer. More...
 
- Public Member Functions inherited from NexTouch
 NexTouch (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)
 Constructor of Nextouch. More...
 
NexPid getPid (void)
 Get page id. More...
 
NexCid getCid (void)
 Get component id. More...
 
const char * getObjName (void)
 Get component name. More...
 
+void print (void)
 Print current object address,page id,component id, component name,pop event function address,push event function address.
 
+ + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from NexTouch
static uint8_t mainEventLoop (NexTouch **list)
 Watting for Nextion's touch event. More...
 
static void sendCommand (const char *cmd)
 Send command to Nextion. More...
 
static bool recvRetCommandFinished (uint32_t timeout=100)
 Command is executed successfully. More...
 
static uint16_t recvRetString (char *buffer, uint16_t len, uint32_t timeout=500)
 Receive string data. More...
 
static bool recvRetNumber (uint32_t *number, uint32_t timeout=500)
 Receive uint32_t data. More...
 
+

Detailed Description

+

NexPointer,subclass of NexTouch,provides simple methods to control pointer component.

+ +

Definition at line 10 of file NexPointer.h.

+

Member Function Documentation

+ +
+
+ + + + + + + + +
bool NexPointer::getValue (uint32_t * number)
+
+ +

Get the value of pointer.

+
Parameters
+ + +
number- an output parameter to save pointer's value.
+
+
+
Return values
+ + + +
true- success.
false- failed.
+
+
+ +

Definition at line 20 of file NexPointer.cpp.

+ +
+
+ +
+
+ + + + + + + + +
bool NexPointer::setValue (uint32_t number)
+
+ +

Set the value of pointer.

+
Parameters
+ + +
number- the value of pointer.
+
+
+
Return values
+ + + +
true- success.
false- failed.
+
+
+ +

Definition at line 37 of file NexPointer.cpp.

+ +
+
+
The documentation for this class was generated from the following files: +
+ + + + diff --git a/doc/API-html/class_nex_pointer.png b/doc/API-html/class_nex_pointer.png new file mode 100644 index 00000000..87aa56e Binary files /dev/null and b/doc/API-html/class_nex_pointer.png differ diff --git a/doc/API-html/class_nex_progress_bar-members.html b/doc/API-html/class_nex_progress_bar-members.html new file mode 100644 index 00000000..db145f7 --- /dev/null +++ b/doc/API-html/class_nex_progress_bar-members.html @@ -0,0 +1,78 @@ + + + + + + +API: Member List + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexProgressBar Member List
+
+
+ +

This is the complete list of members for NexProgressBar, including all inherited members.

+ + + + + + + + + + + + + + +
getCid(void)NexTouch
getObjName(void)NexTouch
getPid(void)NexTouch
getValue(uint32_t *number)NexProgressBar
mainEventLoop(NexTouch **list)NexTouchstatic
NexProgressBar(NexPid pid, NexCid cid, char *name)NexProgressBar
NexTouch(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)NexTouch
print(void)NexTouch
recvRetCommandFinished(uint32_t timeout=100)NexTouchstatic
recvRetNumber(uint32_t *number, uint32_t timeout=500)NexTouchstatic
recvRetString(char *buffer, uint16_t len, uint32_t timeout=500)NexTouchstatic
sendCommand(const char *cmd)NexTouchstatic
setValue(uint32_t number)NexProgressBar
+ + + + diff --git a/doc/API-html/class_nex_progress_bar.html b/doc/API-html/class_nex_progress_bar.html new file mode 100644 index 00000000..d64a444 --- /dev/null +++ b/doc/API-html/class_nex_progress_bar.html @@ -0,0 +1,204 @@ + + + + + + +API: NexProgressBar Class Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Public Member Functions | +List of all members
+
+
NexProgressBar Class Reference
+
+
+ +

NexProgressBar,subclass of NexTouch,provides simple methods to control progress bar component. + More...

+ +

#include <NexProgressBar.h>

+
+Inheritance diagram for NexProgressBar:
+
+
+ + +NexTouch + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

NexProgressBar (NexPid pid, NexCid cid, char *name)
 Constructor,inherited NexTouch's constructor function.
 
bool getValue (uint32_t *number)
 Get the value of progress bar. More...
 
bool setValue (uint32_t number)
 Set the value of progress bar. More...
 
- Public Member Functions inherited from NexTouch
 NexTouch (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)
 Constructor of Nextouch. More...
 
NexPid getPid (void)
 Get page id. More...
 
NexCid getCid (void)
 Get component id. More...
 
const char * getObjName (void)
 Get component name. More...
 
+void print (void)
 Print current object address,page id,component id, component name,pop event function address,push event function address.
 
+ + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from NexTouch
static uint8_t mainEventLoop (NexTouch **list)
 Watting for Nextion's touch event. More...
 
static void sendCommand (const char *cmd)
 Send command to Nextion. More...
 
static bool recvRetCommandFinished (uint32_t timeout=100)
 Command is executed successfully. More...
 
static uint16_t recvRetString (char *buffer, uint16_t len, uint32_t timeout=500)
 Receive string data. More...
 
static bool recvRetNumber (uint32_t *number, uint32_t timeout=500)
 Receive uint32_t data. More...
 
+

Detailed Description

+

NexProgressBar,subclass of NexTouch,provides simple methods to control progress bar component.

+ +

Definition at line 25 of file NexProgressBar.h.

+

Member Function Documentation

+ +
+
+ + + + + + + + +
bool NexProgressBar::getValue (uint32_t * number)
+
+ +

Get the value of progress bar.

+
Parameters
+ + +
number- an output parameter to save the value of porgress bar.
+
+
+
Return values
+ + + +
true- success.
false- failed.
+
+
+ +

Definition at line 35 of file NexProgressBar.cpp.

+ +
+
+ +
+
+ + + + + + + + +
bool NexProgressBar::setValue (uint32_t number)
+
+ +

Set the value of progress bar.

+
Parameters
+ + +
number- the value of progress bar.
+
+
+
Return values
+ + + +
true- success.
false- failed.
+
+
+ +

Definition at line 52 of file NexProgressBar.cpp.

+ +
+
+
The documentation for this class was generated from the following files: +
+ + + + diff --git a/doc/API-html/class_nex_progress_bar.png b/doc/API-html/class_nex_progress_bar.png new file mode 100644 index 00000000..bcb63f0 Binary files /dev/null and b/doc/API-html/class_nex_progress_bar.png differ diff --git a/doc/API-html/class_nex_slice-members.html b/doc/API-html/class_nex_slice-members.html new file mode 100644 index 00000000..2368b04 --- /dev/null +++ b/doc/API-html/class_nex_slice-members.html @@ -0,0 +1,78 @@ + + + + + + +API: Member List + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexSlice Member List
+
+
+ +

This is the complete list of members for NexSlice, including all inherited members.

+ + + + + + + + + + + + + + +
attachPop(NexTouchEventCb pop, void *ptr=NULL)NexSlice
detachPop(void)NexSlice
getCid(void)NexTouch
getObjName(void)NexTouch
getPid(void)NexTouch
mainEventLoop(NexTouch **list)NexTouchstatic
NexSlice(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)NexSlice
NexTouch(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)NexTouch
print(void)NexTouch
recvRetCommandFinished(uint32_t timeout=100)NexTouchstatic
recvRetNumber(uint32_t *number, uint32_t timeout=500)NexTouchstatic
recvRetString(char *buffer, uint16_t len, uint32_t timeout=500)NexTouchstatic
sendCommand(const char *cmd)NexTouchstatic
+ + + + diff --git a/doc/API-html/class_nex_slice.html b/doc/API-html/class_nex_slice.html new file mode 100644 index 00000000..b3ae5e5 --- /dev/null +++ b/doc/API-html/class_nex_slice.html @@ -0,0 +1,176 @@ + + + + + + +API: NexSlice Class Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Public Member Functions | +List of all members
+
+
NexSlice Class Reference
+
+
+ +

NexSlice,subclass of NexTouch,provides simple methods to control slice component. + More...

+ +

#include <NexSlice.h>

+
+Inheritance diagram for NexSlice:
+
+
+ + +NexTouch + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

NexSlice (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)
 Constructor,inherited NexTouch's constructor function.
 
void attachPop (NexTouchEventCb pop, void *ptr=NULL)
 Register slice pop callback function. More...
 
+void detachPop (void)
 Unload slice pop callback function.
 
- Public Member Functions inherited from NexTouch
 NexTouch (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)
 Constructor of Nextouch. More...
 
NexPid getPid (void)
 Get page id. More...
 
NexCid getCid (void)
 Get component id. More...
 
const char * getObjName (void)
 Get component name. More...
 
+void print (void)
 Print current object address,page id,component id, component name,pop event function address,push event function address.
 
+ + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from NexTouch
static uint8_t mainEventLoop (NexTouch **list)
 Watting for Nextion's touch event. More...
 
static void sendCommand (const char *cmd)
 Send command to Nextion. More...
 
static bool recvRetCommandFinished (uint32_t timeout=100)
 Command is executed successfully. More...
 
static uint16_t recvRetString (char *buffer, uint16_t len, uint32_t timeout=500)
 Receive string data. More...
 
static bool recvRetNumber (uint32_t *number, uint32_t timeout=500)
 Receive uint32_t data. More...
 
+

Detailed Description

+

NexSlice,subclass of NexTouch,provides simple methods to control slice component.

+ +

Definition at line 25 of file NexSlice.h.

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
void NexSlice::attachPop (NexTouchEventCb pop,
void * ptr = NULL 
)
+
+ +

Register slice pop callback function.

+
Parameters
+ + + +
pop- the pointer to slice pop callback function.
ptr- the parameter to be transmitted to slice pop callback function.
+
+
+ +

Definition at line 72 of file NexSlice.cpp.

+ +
+
+
The documentation for this class was generated from the following files: +
+ + + + diff --git a/doc/API-html/class_nex_slice.png b/doc/API-html/class_nex_slice.png new file mode 100644 index 00000000..31250a9 Binary files /dev/null and b/doc/API-html/class_nex_slice.png differ diff --git a/doc/API-html/class_nex_text-members.html b/doc/API-html/class_nex_text-members.html new file mode 100644 index 00000000..02bb96d --- /dev/null +++ b/doc/API-html/class_nex_text-members.html @@ -0,0 +1,80 @@ + + + + + + +API: Member List + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexText Member List
+
+
+ +

This is the complete list of members for NexText, including all inherited members.

+ + + + + + + + + + + + + + + + +
attachPop(NexTouchEventCb pop, void *ptr=NULL)NexText
detachPop(void)NexText
getCid(void)NexTouch
getObjName(void)NexTouch
getPid(void)NexTouch
getText(char *buffer, uint16_t len)NexText
mainEventLoop(NexTouch **list)NexTouchstatic
NexText(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)NexText
NexTouch(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)NexTouch
print(void)NexTouch
recvRetCommandFinished(uint32_t timeout=100)NexTouchstatic
recvRetNumber(uint32_t *number, uint32_t timeout=500)NexTouchstatic
recvRetString(char *buffer, uint16_t len, uint32_t timeout=500)NexTouchstatic
sendCommand(const char *cmd)NexTouchstatic
setText(const char *buffer)NexText
+ + + + diff --git a/doc/API-html/class_nex_text.html b/doc/API-html/class_nex_text.html new file mode 100644 index 00000000..cee9b17 --- /dev/null +++ b/doc/API-html/class_nex_text.html @@ -0,0 +1,253 @@ + + + + + + +API: NexText Class Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Public Member Functions | +List of all members
+
+
NexText Class Reference
+
+
+ +

NexText,subclass of NexTouch,provides simple methods to control text component. + More...

+ +

#include <NexText.h>

+
+Inheritance diagram for NexText:
+
+
+ + +NexTouch + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

NexText (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)
 Constructor,inherited NexTouch's constructor function.
 
void attachPop (NexTouchEventCb pop, void *ptr=NULL)
 Register text pop callback function. More...
 
+void detachPop (void)
 Unload text pop callback function.
 
uint16_t getText (char *buffer, uint16_t len)
 Get the value of text. More...
 
bool setText (const char *buffer)
 Set the value of text. More...
 
- Public Member Functions inherited from NexTouch
 NexTouch (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)
 Constructor of Nextouch. More...
 
NexPid getPid (void)
 Get page id. More...
 
NexCid getCid (void)
 Get component id. More...
 
const char * getObjName (void)
 Get component name. More...
 
+void print (void)
 Print current object address,page id,component id, component name,pop event function address,push event function address.
 
+ + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from NexTouch
static uint8_t mainEventLoop (NexTouch **list)
 Watting for Nextion's touch event. More...
 
static void sendCommand (const char *cmd)
 Send command to Nextion. More...
 
static bool recvRetCommandFinished (uint32_t timeout=100)
 Command is executed successfully. More...
 
static uint16_t recvRetString (char *buffer, uint16_t len, uint32_t timeout=500)
 Receive string data. More...
 
static bool recvRetNumber (uint32_t *number, uint32_t timeout=500)
 Receive uint32_t data. More...
 
+

Detailed Description

+

NexText,subclass of NexTouch,provides simple methods to control text component.

+ +

Definition at line 25 of file NexText.h.

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
void NexText::attachPop (NexTouchEventCb pop,
void * ptr = NULL 
)
+
+ +

Register text pop callback function.

+
Parameters
+ + + +
pop- the pointer to text pop callback function.
ptr- the parameter to be transmitted to text pop callback function.
+
+
+ +

Definition at line 70 of file NexText.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
uint16_t NexText::getText (char * buffer,
uint16_t len 
)
+
+ +

Get the value of text.

+
Parameters
+ + + +
buffer- text value buffer.
len- the length of text value buffer.
+
+
+
Returns
the the length of text value buffer.
+ +

Definition at line 35 of file NexText.cpp.

+ +
+
+ +
+
+ + + + + + + + +
bool NexText::setText (const char * buffer)
+
+ +

Set the value of text.

+
Parameters
+ + +
buffer- text value buffer.
+
+
+
Return values
+ + + +
true- success.
false- failed.
+
+
+ +

Definition at line 53 of file NexText.cpp.

+ +
+
+
The documentation for this class was generated from the following files: +
+ + + + diff --git a/doc/API-html/class_nex_text.png b/doc/API-html/class_nex_text.png new file mode 100644 index 00000000..5ff4643 Binary files /dev/null and b/doc/API-html/class_nex_text.png differ diff --git a/doc/API-html/class_nex_touch-members.html b/doc/API-html/class_nex_touch-members.html new file mode 100644 index 00000000..0627a9b --- /dev/null +++ b/doc/API-html/class_nex_touch-members.html @@ -0,0 +1,75 @@ + + + + + + +API: Member List + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
NexTouch Member List
+
+
+ +

This is the complete list of members for NexTouch, including all inherited members.

+ + + + + + + + + + + +
getCid(void)NexTouch
getObjName(void)NexTouch
getPid(void)NexTouch
mainEventLoop(NexTouch **list)NexTouchstatic
NexTouch(NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)NexTouch
print(void)NexTouch
recvRetCommandFinished(uint32_t timeout=100)NexTouchstatic
recvRetNumber(uint32_t *number, uint32_t timeout=500)NexTouchstatic
recvRetString(char *buffer, uint16_t len, uint32_t timeout=500)NexTouchstatic
sendCommand(const char *cmd)NexTouchstatic
+ + + + diff --git a/doc/API-html/class_nex_touch.html b/doc/API-html/class_nex_touch.html new file mode 100644 index 00000000..b274ed0 --- /dev/null +++ b/doc/API-html/class_nex_touch.html @@ -0,0 +1,485 @@ + + + + + + +API: NexTouch Class Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+Public Member Functions | +Static Public Member Functions | +List of all members
+
+
NexTouch Class Reference
+
+
+ +

Root Class of Nextion Components. + More...

+ +

#include <NexTouch.h>

+
+Inheritance diagram for NexTouch:
+
+
+ + +NexButton +NexHotspot +NexPage +NexPicture +NexPointer +NexProgressBar +NexSlice +NexText + +
+ + + + + + + + + + + + + + + + + +

+Public Member Functions

 NexTouch (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)
 Constructor of Nextouch. More...
 
NexPid getPid (void)
 Get page id. More...
 
NexCid getCid (void)
 Get component id. More...
 
const char * getObjName (void)
 Get component name. More...
 
+void print (void)
 Print current object address,page id,component id, component name,pop event function address,push event function address.
 
+ + + + + + + + + + + + + + + + +

+Static Public Member Functions

static uint8_t mainEventLoop (NexTouch **list)
 Watting for Nextion's touch event. More...
 
static void sendCommand (const char *cmd)
 Send command to Nextion. More...
 
static bool recvRetCommandFinished (uint32_t timeout=100)
 Command is executed successfully. More...
 
static uint16_t recvRetString (char *buffer, uint16_t len, uint32_t timeout=500)
 Receive string data. More...
 
static bool recvRetNumber (uint32_t *number, uint32_t timeout=500)
 Receive uint32_t data. More...
 
+

Detailed Description

+

Root Class of Nextion Components.

+
Examples:
CompHotspot.ino.
+
+

Definition at line 63 of file NexTouch.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NexTouch::NexTouch (NexPid pid,
NexCid cid,
char * name,
NexTouchEventCb pop = NULL,
void * pop_ptr = NULL,
NexTouchEventCb push = NULL,
void * push_ptr = NULL 
)
+
+ +

Constructor of Nextouch.

+
Parameters
+ + + + + + + + +
pid- page id.
cid- component id.
name- component name.
pop- pop event function pointer.
pop_str- the parameter was transmitted to pop event function pointer.
push- push event function pointer.
push_ptr- the parameter was transmitted to push event function pointer.
+
+
+ +

Definition at line 74 of file NexTouch.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + +
NexCid NexTouch::getCid (void )
+
+ +

Get component id.

+
Returns
the id of component.
+ +

Definition at line 102 of file NexTouch.cpp.

+ +
+
+ +
+
+ + + + + + + + +
const char * NexTouch::getObjName (void )
+
+ +

Get component name.

+
Returns
the name of component.
+ +

Definition at line 112 of file NexTouch.cpp.

+ +
+
+ +
+
+ + + + + + + + +
NexPid NexTouch::getPid (void )
+
+ +

Get page id.

+
Returns
the id of page.
+ +

Definition at line 92 of file NexTouch.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
uint8_t NexTouch::mainEventLoop (NexTouch ** list)
+
+static
+
+ +

Watting for Nextion's touch event.

+
Parameters
+ + +
list- index to Nextion Components list.
+
+
+ +

Definition at line 26 of file NexTouch.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
bool NexTouch::recvRetCommandFinished (uint32_t timeout = 100)
+
+static
+
+ +

Command is executed successfully.

+
Parameters
+ + +
timeout- set timeout time.
+
+
+
Return values
+ + + +
true- success.
false- failed.
+
+
+ +

Definition at line 224 of file NexTouch.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool NexTouch::recvRetNumber (uint32_t * number,
uint32_t timeout = 500 
)
+
+static
+
+ +

Receive uint32_t data.

+
Parameters
+ + + +
number- save uint32_t data.
timeout- set timeout time.
+
+
+
Return values
+ + + +
true- success.
false- failed.
+
+
+ +

Definition at line 356 of file NexTouch.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
uint16_t NexTouch::recvRetString (char * buffer,
uint16_t len,
uint32_t timeout = 500 
)
+
+static
+
+ +

Receive string data.

+
Parameters
+ + + + +
buffer- save string data.
len- string buffer length.
timeout- set timeout time.
+
+
+
Returns
the length of string buffer.
+ +

Definition at line 284 of file NexTouch.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void NexTouch::sendCommand (const char * cmd)
+
+static
+
+ +

Send command to Nextion.

+
Parameters
+ + +
cmd- the string of command.
+
+
+ +

Definition at line 261 of file NexTouch.cpp.

+ +
+
+
The documentation for this class was generated from the following files: +
+ + + + diff --git a/doc/API-html/class_nex_touch.png b/doc/API-html/class_nex_touch.png new file mode 100644 index 00000000..bfafa43 Binary files /dev/null and b/doc/API-html/class_nex_touch.png differ diff --git a/doc/API-html/classes.html b/doc/API-html/classes.html new file mode 100644 index 00000000..84fdc74 --- /dev/null +++ b/doc/API-html/classes.html @@ -0,0 +1,71 @@ + + + + + + +API: Class Index + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
Class Index
+
+
+
N
+ + + + + +
  N  
+
NexHotspot   NexPointer   NexText   
NexPage   NexProgressBar   NexTouch   
NexButton   NexPicture   NexSlice   
+
N
+
+ + + + diff --git a/doc/API-html/closed.png b/doc/API-html/closed.png new file mode 100644 index 00000000..b4853a0 Binary files /dev/null and b/doc/API-html/closed.png differ diff --git a/doc/API-html/dir_0726b97e666c2e7f518aadd1fe5118dc.html b/doc/API-html/dir_0726b97e666c2e7f518aadd1fe5118dc.html new file mode 100644 index 00000000..7745013 --- /dev/null +++ b/doc/API-html/dir_0726b97e666c2e7f518aadd1fe5118dc.html @@ -0,0 +1,64 @@ + + + + + + +API: examples/CompSlice Directory Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
CompSlice Directory Reference
+
+
+ + + + +

+Files

file  CompSlice.ino [code]
 
+
+ + + + diff --git a/doc/API-html/dir_376a8598cfd3d58455c161124a3e8051.html b/doc/API-html/dir_376a8598cfd3d58455c161124a3e8051.html new file mode 100644 index 00000000..0abf4fb --- /dev/null +++ b/doc/API-html/dir_376a8598cfd3d58455c161124a3e8051.html @@ -0,0 +1,64 @@ + + + + + + +API: examples/CompPointer Directory Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
CompPointer Directory Reference
+
+
+ + + + +

+Files

file  CompPointer.ino [code]
 
+
+ + + + diff --git a/doc/API-html/dir_7962cac16a99e8bbaaea18abede03fcb.html b/doc/API-html/dir_7962cac16a99e8bbaaea18abede03fcb.html new file mode 100644 index 00000000..7fec5c5 --- /dev/null +++ b/doc/API-html/dir_7962cac16a99e8bbaaea18abede03fcb.html @@ -0,0 +1,64 @@ + + + + + + +API: examples/CompProgressBar Directory Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
CompProgressBar Directory Reference
+
+
+ + + + +

+Files

file  CompProgressBar.ino [code]
 
+
+ + + + diff --git a/doc/API-html/dir_9bbf8342b0f9a157b7af08fe1412fc17.html b/doc/API-html/dir_9bbf8342b0f9a157b7af08fe1412fc17.html new file mode 100644 index 00000000..4b7bfda --- /dev/null +++ b/doc/API-html/dir_9bbf8342b0f9a157b7af08fe1412fc17.html @@ -0,0 +1,64 @@ + + + + + + +API: examples/CompButton Directory Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
CompButton Directory Reference
+
+
+ + + + +

+Files

file  CompButton.ino [code]
 
+
+ + + + diff --git a/doc/API-html/dir_c918e8bf3fc71f849978cdb0d900e61c.html b/doc/API-html/dir_c918e8bf3fc71f849978cdb0d900e61c.html new file mode 100644 index 00000000..5542eaa --- /dev/null +++ b/doc/API-html/dir_c918e8bf3fc71f849978cdb0d900e61c.html @@ -0,0 +1,64 @@ + + + + + + +API: examples/CompText Directory Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
CompText Directory Reference
+
+
+ + + + +

+Files

file  CompText.ino [code]
 
+
+ + + + diff --git a/doc/API-html/dir_ce36ac18ad3deaf5eae0bd2e09775a7d.html b/doc/API-html/dir_ce36ac18ad3deaf5eae0bd2e09775a7d.html new file mode 100644 index 00000000..804db65 --- /dev/null +++ b/doc/API-html/dir_ce36ac18ad3deaf5eae0bd2e09775a7d.html @@ -0,0 +1,64 @@ + + + + + + +API: examples/CompPicture Directory Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
CompPicture Directory Reference
+
+
+ + + + +

+Files

file  CompPicture.ino [code]
 
+
+ + + + diff --git a/doc/API-html/dir_d28a4824dc47e487b107a5db32ef43c4.html b/doc/API-html/dir_d28a4824dc47e487b107a5db32ef43c4.html new file mode 100644 index 00000000..de617c8 --- /dev/null +++ b/doc/API-html/dir_d28a4824dc47e487b107a5db32ef43c4.html @@ -0,0 +1,78 @@ + + + + + + +API: examples Directory Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
examples Directory Reference
+
+
+ + + + + + + + + + + + + + + + + + +

+Directories

directory  CompButton
 
directory  CompHotspot
 
directory  CompPage
 
directory  CompPicture
 
directory  CompPointer
 
directory  CompProgressBar
 
directory  CompSlice
 
directory  CompText
 
+
+ + + + diff --git a/doc/API-html/dir_f3d39c87bc262720c50d5e3885667b8a.html b/doc/API-html/dir_f3d39c87bc262720c50d5e3885667b8a.html new file mode 100644 index 00000000..0348f55 --- /dev/null +++ b/doc/API-html/dir_f3d39c87bc262720c50d5e3885667b8a.html @@ -0,0 +1,64 @@ + + + + + + +API: examples/CompHotspot Directory Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
CompHotspot Directory Reference
+
+
+ + + + +

+Files

file  CompHotspot.ino [code]
 
+
+ + + + diff --git a/doc/API-html/dir_f76977d9ffe8ddf3ad01f3d689aa5df4.html b/doc/API-html/dir_f76977d9ffe8ddf3ad01f3d689aa5df4.html new file mode 100644 index 00000000..7acc7ea --- /dev/null +++ b/doc/API-html/dir_f76977d9ffe8ddf3ad01f3d689aa5df4.html @@ -0,0 +1,64 @@ + + + + + + +API: examples/CompPage Directory Reference + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
CompPage Directory Reference
+
+
+ + + + +

+Files

file  CompPage.ino [code]
 
+
+ + + + diff --git a/doc/API-html/doxygen.css b/doc/API-html/doxygen.css new file mode 100644 index 00000000..aaf32a3 --- /dev/null +++ b/doc/API-html/doxygen.css @@ -0,0 +1,1440 @@ +/* The standard CSS for doxygen 1.8.7 */ + +body, table, div, p, dl { + font: 400 14px/22px Roboto,sans-serif; +} + +/* @group Heading Levels */ + +h1.groupheader { + font-size: 150%; +} + +.title { + font: 400 14px/28px Roboto,sans-serif; + font-size: 150%; + font-weight: bold; + margin: 10px 2px; +} + +h2.groupheader { + border-bottom: 1px solid #7BB0E5; + color: #1F62A5; + font-size: 150%; + font-weight: normal; + margin-top: 1.75em; + padding-top: 8px; + padding-bottom: 4px; + width: 100%; +} + +h3.groupheader { + font-size: 100%; +} + +h1, h2, h3, h4, h5, h6 { + -webkit-transition: text-shadow 0.5s linear; + -moz-transition: text-shadow 0.5s linear; + -ms-transition: text-shadow 0.5s linear; + -o-transition: text-shadow 0.5s linear; + transition: text-shadow 0.5s linear; + margin-right: 15px; +} + +h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { + text-shadow: 0 0 15px cyan; +} + +dt { + font-weight: bold; +} + +div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; +} + +p.startli, p.startdd { + margin-top: 2px; +} + +p.starttd { + margin-top: 0px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.qindex, div.navtab{ + background-color: #EAF2FB; + border: 1px solid #9AC3EB; + text-align: center; +} + +div.qindex, div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ + +a { + color: #236EB9; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #287ED3; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: #92BEEA; + color: #ffffff; + border: 1px double #79AFE5; +} + +.contents a.qindexHL:visited { + color: #ffffff; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code, a.code:visited, a.line, a.line:visited { + color: #4665A2; +} + +a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited { + color: #4665A2; +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +pre.fragment { + border: 1px solid #C4CFE5; + background-color: #FBFCFD; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; + font-family: monospace, fixed; + font-size: 105%; +} + +div.fragment { + padding: 4px 6px; + margin: 4px 8px 4px 2px; + background-color: #FBFCFE; + border: 1px solid #BFD9F2; +} + +div.line { + font-family: monospace, fixed; + font-size: 13px; + min-height: 13px; + line-height: 1.0; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + text-indent: -53px; + padding-left: 53px; + padding-bottom: 0px; + margin: 0px; + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +div.line.glow { + background-color: cyan; + box-shadow: 0 0 10px cyan; +} + + +span.lineno { + padding-right: 4px; + text-align: right; + border-right: 2px solid #0F0; + background-color: #E8E8E8; + white-space: pre; +} +span.lineno a { + background-color: #D8D8D8; +} + +span.lineno a:hover { + background-color: #C8C8C8; +} + +div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; + box-shadow: 2px 2px 3px #999; + -webkit-box-shadow: 2px 2px 3px #999; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); + background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000); +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background-color: white; + color: black; + margin: 0; +} + +div.contents { + margin-top: 10px; + margin-left: 12px; + margin-right: 8px; +} + +td.indexkey { + background-color: #EAF2FB; + font-weight: bold; + border: 1px solid #BFD9F2; + margin: 2px 0px 2px 0; + padding: 2px 10px; + white-space: nowrap; + vertical-align: top; +} + +td.indexvalue { + background-color: #EAF2FB; + border: 1px solid #BFD9F2; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #ECF4FB; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +address.footer { + text-align: right; + padding-right: 12px; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +blockquote { + background-color: #F6F9FD; + border-left: 2px solid #92BEEA; + margin: 0 24px 0 4px; + padding: 0 12px 0 16px; +} + +/* @end */ + +/* +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +*/ + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #9AC3EB; +} + +th.dirtab { + background: #EAF2FB; + font-weight: bold; +} + +hr { + height: 0px; + border: none; + border-top: 1px solid #3083D7; +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ + +table.memberdecls { + border-spacing: 0px; + padding: 0px; +} + +.memberdecls td, .fieldtable tr { + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +.memberdecls td.glow, .fieldtable tr.glow { + background-color: cyan; + box-shadow: 0 0 15px cyan; +} + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #F8FBFD; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memSeparator { + border-bottom: 1px solid #DEE4F0; + line-height: 1px; + margin: 0px; + padding: 0px; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memItemRight { + width: 100%; +} + +.memTemplParams { + color: #287ED3; + white-space: nowrap; + font-size: 80%; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtemplate { + font-size: 80%; + color: #287ED3; + font-weight: normal; + margin-left: 9px; +} + +.memnav { + background-color: #EAF2FB; + border: 1px solid #9AC3EB; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.mempage { + width: 100%; +} + +.memitem { + padding: 0; + margin-bottom: 10px; + margin-right: 5px; + -webkit-transition: box-shadow 0.5s linear; + -moz-transition: box-shadow 0.5s linear; + -ms-transition: box-shadow 0.5s linear; + -o-transition: box-shadow 0.5s linear; + transition: box-shadow 0.5s linear; + display: table !important; + width: 100%; +} + +.memitem.glow { + box-shadow: 0 0 15px cyan; +} + +.memname { + font-weight: bold; + margin-left: 6px; +} + +.memname td { + vertical-align: bottom; +} + +.memproto, dl.reflist dt { + border-top: 1px solid #A0C6EC; + border-left: 1px solid #A0C6EC; + border-right: 1px solid #A0C6EC; + padding: 6px 0px 6px 0px; + color: #164676; + font-weight: bold; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E0ECF9; + /* opera specific markup */ + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + border-top-right-radius: 4px; + border-top-left-radius: 4px; + /* firefox specific markup */ + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 4px; + -moz-border-radius-topleft: 4px; + /* webkit specific markup */ + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 4px; + -webkit-border-top-left-radius: 4px; + +} + +.memdoc, dl.reflist dd { + border-bottom: 1px solid #A0C6EC; + border-left: 1px solid #A0C6EC; + border-right: 1px solid #A0C6EC; + padding: 6px 10px 2px 10px; + background-color: #FBFCFE; + border-top-width: 0; + background-image:url('nav_g.png'); + background-repeat:repeat-x; + background-color: #FFFFFF; + /* opera specific markup */ + border-bottom-left-radius: 4px; + border-bottom-right-radius: 4px; + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + /* firefox specific markup */ + -moz-border-radius-bottomleft: 4px; + -moz-border-radius-bottomright: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +dl.reflist dt { + padding: 5px; +} + +dl.reflist dd { + margin: 0px 0px 10px 0px; + padding: 5px; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} +.paramname code { + line-height: 14px; +} + +.params, .retval, .exception, .tparams { + margin-left: 0px; + padding-left: 0px; +} + +.params .paramname, .retval .paramname { + font-weight: bold; + vertical-align: top; +} + +.params .paramtype { + font-style: italic; + vertical-align: top; +} + +.params .paramdir { + font-family: "courier new",courier,monospace; + vertical-align: top; +} + +table.mlabels { + border-spacing: 0px; +} + +td.mlabels-left { + width: 100%; + padding: 0px; +} + +td.mlabels-right { + vertical-align: bottom; + padding: 0px; + white-space: nowrap; +} + +span.mlabels { + margin-left: 8px; +} + +span.mlabel { + background-color: #63A2E1; + border-top:1px solid #3F8DDA; + border-left:1px solid #3F8DDA; + border-right:1px solid #BFD9F2; + border-bottom:1px solid #BFD9F2; + text-shadow: none; + color: white; + margin-right: 4px; + padding: 2px 3px; + border-radius: 3px; + font-size: 7pt; + white-space: nowrap; + vertical-align: middle; +} + + + +/* @end */ + +/* these are for tree view inside a (index) page */ + +div.directory { + margin: 10px 0px; + border-top: 1px solid #92BEEA; + border-bottom: 1px solid #92BEEA; + width: 100%; +} + +.directory table { + border-collapse:collapse; +} + +.directory td { + margin: 0px; + padding: 0px; + vertical-align: top; +} + +.directory td.entry { + white-space: nowrap; + padding-right: 6px; + padding-top: 3px; +} + +.directory td.entry a { + outline:none; +} + +.directory td.entry a img { + border: none; +} + +.directory td.desc { + width: 100%; + padding-left: 6px; + padding-right: 6px; + padding-top: 3px; + border-left: 1px solid rgba(0,0,0,0.05); +} + +.directory tr.even { + padding-left: 6px; + background-color: #F6F9FD; +} + +.directory img { + vertical-align: -30%; +} + +.directory .levels { + white-space: nowrap; + width: 100%; + text-align: right; + font-size: 9pt; +} + +.directory .levels span { + cursor: pointer; + padding-left: 2px; + padding-right: 2px; + color: #236EB9; +} + +.arrow { + color: #92BEEA; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + font-size: 80%; + display: inline-block; + width: 16px; + height: 22px; +} + +.icon { + font-family: Arial, Helvetica; + font-weight: bold; + font-size: 12px; + height: 14px; + width: 16px; + display: inline-block; + background-color: #63A2E1; + color: white; + text-align: center; + border-radius: 4px; + margin-left: 2px; + margin-right: 2px; +} + +.icona { + width: 24px; + height: 22px; + display: inline-block; +} + +.iconfopen { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('ftv2folderopen.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.iconfclosed { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('ftv2folderclosed.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.icondoc { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('ftv2doc.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +table.directory { + font: 400 14px Roboto,sans-serif; +} + +/* @end */ + +div.dynheader { + margin-top: 8px; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +address { + font-style: normal; + color: #195086; +} + +table.doxtable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #1B548D; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #2065AA; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +table.fieldtable { + /*width: 100%;*/ + margin-bottom: 10px; + border: 1px solid #A0C6EC; + border-spacing: 0px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + border-radius: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); + box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); +} + +.fieldtable td, .fieldtable th { + padding: 3px 7px 2px; +} + +.fieldtable td.fieldtype, .fieldtable td.fieldname { + white-space: nowrap; + border-right: 1px solid #A0C6EC; + border-bottom: 1px solid #A0C6EC; + vertical-align: top; +} + +.fieldtable td.fieldname { + padding-top: 3px; +} + +.fieldtable td.fielddoc { + border-bottom: 1px solid #A0C6EC; + /*width: 100%;*/ +} + +.fieldtable td.fielddoc p:first-child { + margin-top: 0px; +} + +.fieldtable td.fielddoc p:last-child { + margin-bottom: 2px; +} + +.fieldtable tr:last-child td { + border-bottom: none; +} + +.fieldtable th { + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E0ECF9; + font-size: 90%; + color: #164676; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; + -moz-border-radius-topleft: 4px; + -moz-border-radius-topright: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + border-top-left-radius: 4px; + border-top-right-radius: 4px; + border-bottom: 1px solid #A0C6EC; +} + + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + background-image:url('tab_b.png'); + background-repeat:repeat-x; + background-position: 0 -5px; + height:30px; + line-height:30px; + color:#7EB2E6; + border:solid 1px #BCD7F2; + overflow:hidden; + margin:0px; + padding:0px; +} + +.navpath li +{ + list-style-type:none; + float:left; + padding-left:10px; + padding-right:15px; + background-image:url('bc_s.png'); + background-repeat:no-repeat; + background-position:right; + color:#1F63A6; +} + +.navpath li.navelem a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; + color: #184C80; + font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + text-decoration: none; +} + +.navpath li.navelem a:hover +{ + color:#579BDE; +} + +.navpath li.footer +{ + list-style-type:none; + float:right; + padding-left:10px; + padding-right:15px; + background-image:none; + background-repeat:no-repeat; + background-position:right; + color:#1F63A6; + font-size: 8pt; +} + + +div.summary +{ + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a +{ + white-space: nowrap; +} + +div.ingroups +{ + font-size: 8pt; + width: 50%; + text-align: left; +} + +div.ingroups a +{ + white-space: nowrap; +} + +div.header +{ + background-image:url('nav_h.png'); + background-repeat:repeat-x; + background-color: #F8FBFD; + margin: 0px; + border-bottom: 1px solid #BFD9F2; +} + +div.headertitle +{ + padding: 5px 5px 5px 10px; +} + +dl +{ + padding: 0 0 0 10px; +} + +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */ +dl.section +{ + margin-left: 0px; + padding-left: 0px; +} + +dl.note +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #D0C000; +} + +dl.warning, dl.attention +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #FF0000; +} + +dl.pre, dl.post, dl.invariant +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #00D000; +} + +dl.deprecated +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #505050; +} + +dl.todo +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #00C0E0; +} + +dl.test +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #3030E0; +} + +dl.bug +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #C08050; +} + +dl.section dd { + margin-bottom: 6px; +} + + +#projectlogo +{ + text-align: center; + vertical-align: bottom; + border-collapse: separate; +} + +#projectlogo img +{ + border: 0px none; +} + +#projectname +{ + font: 300% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 2px 0px; +} + +#projectbrief +{ + font: 120% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#projectnumber +{ + font: 50% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#titlearea +{ + padding: 0px; + margin: 0px; + width: 100%; + border-bottom: 1px solid #3F8DDA; +} + +.image +{ + text-align: center; +} + +.dotgraph +{ + text-align: center; +} + +.mscgraph +{ + text-align: center; +} + +.diagraph +{ + text-align: center; +} + +.caption +{ + font-weight: bold; +} + +div.zoom +{ + border: 1px solid #84B6E7; +} + +dl.citelist { + margin-bottom:50px; +} + +dl.citelist dt { + color:#1E5E9E; + float:left; + font-weight:bold; + margin-right:10px; + padding:5px; +} + +dl.citelist dd { + margin:2px 0; + padding:5px 0; +} + +div.toc { + padding: 14px 25px; + background-color: #F4F8FC; + border: 1px solid #D5E6F6; + border-radius: 7px 7px 7px 7px; + float: right; + height: auto; + margin: 0 20px 10px 10px; + width: 200px; +} + +div.toc li { + background: url("bdwn.png") no-repeat scroll 0 5px transparent; + font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; + margin-top: 5px; + padding-left: 10px; + padding-top: 2px; +} + +div.toc h3 { + font: bold 12px/1.2 Arial,FreeSans,sans-serif; + color: #287ED3; + border-bottom: 0 none; + margin: 0; +} + +div.toc ul { + list-style: none outside none; + border: medium none; + padding: 0px; +} + +div.toc li.level1 { + margin-left: 0px; +} + +div.toc li.level2 { + margin-left: 15px; +} + +div.toc li.level3 { + margin-left: 30px; +} + +div.toc li.level4 { + margin-left: 45px; +} + +.inherit_header { + font-weight: bold; + color: gray; + cursor: pointer; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.inherit_header td { + padding: 6px 0px 2px 5px; +} + +.inherit { + display: none; +} + +tr.heading h2 { + margin-top: 12px; + margin-bottom: 4px; +} + +/* tooltip related style info */ + +.ttc { + position: absolute; + display: none; +} + +#powerTip { + cursor: default; + white-space: nowrap; + background-color: white; + border: 1px solid gray; + border-radius: 4px 4px 4px 4px; + box-shadow: 1px 1px 7px gray; + display: none; + font-size: smaller; + max-width: 80%; + opacity: 0.9; + padding: 1ex 1em 1em; + position: absolute; + z-index: 2147483647; +} + +#powerTip div.ttdoc { + color: grey; + font-style: italic; +} + +#powerTip div.ttname a { + font-weight: bold; +} + +#powerTip div.ttname { + font-weight: bold; +} + +#powerTip div.ttdeci { + color: #006318; +} + +#powerTip div { + margin: 0px; + padding: 0px; + font: 12px/16px Roboto,sans-serif; +} + +#powerTip:before, #powerTip:after { + content: ""; + position: absolute; + margin: 0px; +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.s:after, #powerTip.s:before, +#powerTip.w:after, #powerTip.w:before, +#powerTip.e:after, #powerTip.e:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.nw:after, #powerTip.nw:before, +#powerTip.sw:after, #powerTip.sw:before { + border: solid transparent; + content: " "; + height: 0; + width: 0; + position: absolute; +} + +#powerTip.n:after, #powerTip.s:after, +#powerTip.w:after, #powerTip.e:after, +#powerTip.nw:after, #powerTip.ne:after, +#powerTip.sw:after, #powerTip.se:after { + border-color: rgba(255, 255, 255, 0); +} + +#powerTip.n:before, #powerTip.s:before, +#powerTip.w:before, #powerTip.e:before, +#powerTip.nw:before, #powerTip.ne:before, +#powerTip.sw:before, #powerTip.se:before { + border-color: rgba(128, 128, 128, 0); +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.nw:after, #powerTip.nw:before { + top: 100%; +} + +#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after { + border-top-color: #ffffff; + border-width: 10px; + margin: 0px -10px; +} +#powerTip.n:before { + border-top-color: #808080; + border-width: 11px; + margin: 0px -11px; +} +#powerTip.n:after, #powerTip.n:before { + left: 50%; +} + +#powerTip.nw:after, #powerTip.nw:before { + right: 14px; +} + +#powerTip.ne:after, #powerTip.ne:before { + left: 14px; +} + +#powerTip.s:after, #powerTip.s:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.sw:after, #powerTip.sw:before { + bottom: 100%; +} + +#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after { + border-bottom-color: #ffffff; + border-width: 10px; + margin: 0px -10px; +} + +#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before { + border-bottom-color: #808080; + border-width: 11px; + margin: 0px -11px; +} + +#powerTip.s:after, #powerTip.s:before { + left: 50%; +} + +#powerTip.sw:after, #powerTip.sw:before { + right: 14px; +} + +#powerTip.se:after, #powerTip.se:before { + left: 14px; +} + +#powerTip.e:after, #powerTip.e:before { + left: 100%; +} +#powerTip.e:after { + border-left-color: #ffffff; + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.e:before { + border-left-color: #808080; + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +#powerTip.w:after, #powerTip.w:before { + right: 100%; +} +#powerTip.w:after { + border-right-color: #ffffff; + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.w:before { + border-right-color: #808080; + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +@media print +{ + #top { display: none; } + #side-nav { display: none; } + #nav-path { display: none; } + body { overflow:visible; } + h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } + .summary { display: none; } + .memitem { page-break-inside: avoid; } + #doc-content + { + margin-left:0 !important; + height:auto !important; + width:auto !important; + overflow:inherit; + display:inline; + } +} + diff --git a/doc/API-html/doxygen.png b/doc/API-html/doxygen.png new file mode 100644 index 00000000..33af278 Binary files /dev/null and b/doc/API-html/doxygen.png differ diff --git a/doc/API-html/dynsections.js b/doc/API-html/dynsections.js new file mode 100644 index 00000000..1e6bf07 --- /dev/null +++ b/doc/API-html/dynsections.js @@ -0,0 +1,104 @@ +function toggleVisibility(linkObj) +{ + var base = $(linkObj).attr('id'); + var summary = $('#'+base+'-summary'); + var content = $('#'+base+'-content'); + var trigger = $('#'+base+'-trigger'); + var src=$(trigger).attr('src'); + if (content.is(':visible')===true) { + content.hide(); + summary.show(); + $(linkObj).addClass('closed').removeClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png'); + } else { + content.show(); + summary.hide(); + $(linkObj).removeClass('closed').addClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-10)+'open.png'); + } + return false; +} + +function updateStripes() +{ + $('table.directory tr'). + removeClass('even').filter(':visible:even').addClass('even'); +} + +function toggleLevel(level) +{ + $('table.directory tr').each(function() { + var l = this.id.split('_').length-1; + var i = $('#img'+this.id.substring(3)); + var a = $('#arr'+this.id.substring(3)); + if (l + + + + + +API: Examples + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + +
+
+
+
Examples
+
+
+
Here is a list of all examples:
+
+ + + + diff --git a/doc/API-html/files.html b/doc/API-html/files.html new file mode 100644 index 00000000..edbee78 --- /dev/null +++ b/doc/API-html/files.html @@ -0,0 +1,99 @@ + + + + + + +API: File List + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
File List
+
+
+
Here is a list of all documented files with brief descriptions:
+
[detail level 123]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
  examples
  CompButton
 CompButton.ino
  CompHotspot
 CompHotspot.ino
  CompPage
 CompPage.ino
  CompPicture
 CompPicture.ino
  CompPointer
 CompPointer.ino
  CompProgressBar
 CompProgressBar.ino
  CompSlice
 CompSlice.ino
  CompText
 CompText.ino
 NexButton.cppAPI of NexButton
 NexButton.hAPI of NexButton
 NexHotspot.cppAPI of NexHotspot
 NexHotspot.hAPI of NexHotspot
 NexPage.cppAPI of NexPage
 NexPage.hAPI of NexPage
 NexPicture.cppAPI of NexPicture
 NexPicture.hAPI of NexPicture
 NexPointer.cpp
 NexPointer.h
 NexProgressBar.cppAPI of NexProgressBar
 NexProgressBar.hAPI of NexProgressBar
 NexSlice.cppAPI of NexSlice
 NexSlice.hAPI of NexSlice
 NexText.cppAPI of NexText
 NexText.hAPI of NexText
 NexTouch.cppAPI of Nextion
 NexTouch.hAPI of Nextion
+
+
+ + + + diff --git a/doc/API-html/ftv2blank.png b/doc/API-html/ftv2blank.png new file mode 100644 index 00000000..63c605b Binary files /dev/null and b/doc/API-html/ftv2blank.png differ diff --git a/doc/API-html/ftv2doc.png b/doc/API-html/ftv2doc.png new file mode 100644 index 00000000..da86f46 Binary files /dev/null and b/doc/API-html/ftv2doc.png differ diff --git a/doc/API-html/ftv2folderclosed.png b/doc/API-html/ftv2folderclosed.png new file mode 100644 index 00000000..f840d2a Binary files /dev/null and b/doc/API-html/ftv2folderclosed.png differ diff --git a/doc/API-html/ftv2folderopen.png b/doc/API-html/ftv2folderopen.png new file mode 100644 index 00000000..563d613 Binary files /dev/null and b/doc/API-html/ftv2folderopen.png differ diff --git a/doc/API-html/ftv2lastnode.png b/doc/API-html/ftv2lastnode.png new file mode 100644 index 00000000..63c605b Binary files /dev/null and b/doc/API-html/ftv2lastnode.png differ diff --git a/doc/API-html/ftv2link.png b/doc/API-html/ftv2link.png new file mode 100644 index 00000000..da86f46 Binary files /dev/null and b/doc/API-html/ftv2link.png differ diff --git a/doc/API-html/ftv2mlastnode.png b/doc/API-html/ftv2mlastnode.png new file mode 100644 index 00000000..2ab84ef Binary files /dev/null and b/doc/API-html/ftv2mlastnode.png differ diff --git a/doc/API-html/ftv2mnode.png b/doc/API-html/ftv2mnode.png new file mode 100644 index 00000000..2ab84ef Binary files /dev/null and b/doc/API-html/ftv2mnode.png differ diff --git a/doc/API-html/ftv2node.png b/doc/API-html/ftv2node.png new file mode 100644 index 00000000..63c605b Binary files /dev/null and b/doc/API-html/ftv2node.png differ diff --git a/doc/API-html/ftv2plastnode.png b/doc/API-html/ftv2plastnode.png new file mode 100644 index 00000000..c56911a Binary files /dev/null and b/doc/API-html/ftv2plastnode.png differ diff --git a/doc/API-html/ftv2pnode.png b/doc/API-html/ftv2pnode.png new file mode 100644 index 00000000..c56911a Binary files /dev/null and b/doc/API-html/ftv2pnode.png differ diff --git a/doc/API-html/ftv2splitbar.png b/doc/API-html/ftv2splitbar.png new file mode 100644 index 00000000..587f721 Binary files /dev/null and b/doc/API-html/ftv2splitbar.png differ diff --git a/doc/API-html/ftv2vertline.png b/doc/API-html/ftv2vertline.png new file mode 100644 index 00000000..63c605b Binary files /dev/null and b/doc/API-html/ftv2vertline.png differ diff --git a/doc/API-html/functions.html b/doc/API-html/functions.html new file mode 100644 index 00000000..c7e09ea --- /dev/null +++ b/doc/API-html/functions.html @@ -0,0 +1,209 @@ + + + + + + +API: Class Members + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + + + +
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+ +

- a -

+ + +

- d -

+ + +

- g -

+ + +

- m -

+ + +

- n -

+ + +

- p -

+ + +

- r -

+ + +

- s -

+
+ + + + diff --git a/doc/API-html/functions_func.html b/doc/API-html/functions_func.html new file mode 100644 index 00000000..dbe86f1 --- /dev/null +++ b/doc/API-html/functions_func.html @@ -0,0 +1,209 @@ + + + + + + +API: Class Members - Functions + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + + + +
+
+  + +

- a -

+ + +

- d -

+ + +

- g -

+ + +

- m -

+ + +

- n -

+ + +

- p -

+ + +

- r -

+ + +

- s -

+
+ + + + diff --git a/doc/API-html/globals.html b/doc/API-html/globals.html new file mode 100644 index 00000000..1634953 --- /dev/null +++ b/doc/API-html/globals.html @@ -0,0 +1,72 @@ + + + + + + +API: File Members + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + + +
+
+
Here is a list of all documented file members with links to the documentation:
+
+ + + + diff --git a/doc/API-html/globals_func.html b/doc/API-html/globals_func.html new file mode 100644 index 00000000..8b9265f --- /dev/null +++ b/doc/API-html/globals_func.html @@ -0,0 +1,72 @@ + + + + + + +API: File Members + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + + +
+
+
+ + + + diff --git a/doc/API-html/hierarchy.html b/doc/API-html/hierarchy.html new file mode 100644 index 00000000..665169e --- /dev/null +++ b/doc/API-html/hierarchy.html @@ -0,0 +1,75 @@ + + + + + + +API: Class Hierarchy + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
Class Hierarchy
+
+
+
This inheritance list is sorted roughly, but not completely, alphabetically:
+
[detail level 12]
+ + + + + + + + + +
 CNexTouchRoot Class of Nextion Components
 CNexButtonNexButton,subclass of NexTouch,provides simple methods to control button component
 CNexHotspotNexHotspot,subclass of NexTouch,provides simple methods to control hotspot component
 CNexPageNexPage,subclass of NexTouch,provides simple methods to control page component
 CNexPictureNexPicture,subclass of NexTouch,provides simple methods to control picture component
 CNexPointerNexPointer,subclass of NexTouch,provides simple methods to control pointer component
 CNexProgressBarNexProgressBar,subclass of NexTouch,provides simple methods to control progress bar component
 CNexSliceNexSlice,subclass of NexTouch,provides simple methods to control slice component
 CNexTextNexText,subclass of NexTouch,provides simple methods to control text component
+
+
+ + + + diff --git a/doc/API-html/index.hhc b/doc/API-html/index.hhc new file mode 100644 index 00000000..4eec800 --- /dev/null +++ b/doc/API-html/index.hhc @@ -0,0 +1,253 @@ + + + + + + + + diff --git a/doc/API-html/index.hhk b/doc/API-html/index.hhk new file mode 100644 index 00000000..79eaafc --- /dev/null +++ b/doc/API-html/index.hhk @@ -0,0 +1,153 @@ + + + + + + + + diff --git a/doc/API-html/index.hhp b/doc/API-html/index.hhp new file mode 100644 index 00000000..8327a71 --- /dev/null +++ b/doc/API-html/index.hhp @@ -0,0 +1,135 @@ +[OPTIONS] +Compiled file=../API.chm +Compatibility=1.1 +Full-text search=Yes +Contents file=index.hhc +Default Window=main +Default topic=index.html +Index file=index.hhk +Language=0x409 English (United States) +Title=API + +[WINDOWS] +main="API","index.hhc","index.hhk","index.html","index.html",,,,,0x23520,,0x10387e,,,,,,,,0 + +[FILES] +_comp_hotspot_8ino-example.html +_nex_touch_8cpp-example.html +_comp_button_8ino_source.html +_comp_hotspot_8ino_source.html +_comp_page_8ino_source.html +_comp_picture_8ino_source.html +_comp_pointer_8ino_source.html +_comp_progress_bar_8ino_source.html +_comp_slice_8ino_source.html +_comp_text_8ino_source.html +_nex_button_8cpp_source.html +_nex_button_8h_source.html +_nex_hotspot_8cpp_source.html +_nex_hotspot_8h_source.html +_nex_page_8cpp_source.html +_nex_page_8h_source.html +_nex_picture_8cpp_source.html +_nex_picture_8h_source.html +_nex_pointer_8cpp_source.html +_nex_pointer_8h_source.html +_nex_progress_bar_8cpp_source.html +_nex_progress_bar_8h_source.html +_nex_slice_8cpp_source.html +_nex_slice_8h_source.html +_nex_text_8cpp_source.html +_nex_text_8h_source.html +_nex_touch_8cpp_source.html +_nex_touch_8h_source.html +readme_8md_source.html +_nex_button_8cpp.html +_nex_button_8h.html +_nex_hotspot_8cpp.html +_nex_hotspot_8h.html +_nex_page_8cpp.html +_nex_page_8h.html +_nex_picture_8cpp.html +_nex_picture_8h.html +_nex_progress_bar_8cpp.html +_nex_progress_bar_8h.html +_nex_slice_8cpp.html +_nex_slice_8h.html +_nex_text_8cpp.html +_nex_text_8h.html +_nex_touch_8cpp.html +_nex_touch_8h.html +md_readme.html +class_nex_button.html +class_nex_button-members.html +class_nex_hotspot.html +class_nex_hotspot-members.html +class_nex_page.html +class_nex_page-members.html +class_nex_picture.html +class_nex_picture-members.html +class_nex_pointer.html +class_nex_pointer-members.html +class_nex_progress_bar.html +class_nex_progress_bar-members.html +class_nex_slice.html +class_nex_slice-members.html +class_nex_text.html +class_nex_text-members.html +class_nex_touch.html +class_nex_touch-members.html +dir_9bbf8342b0f9a157b7af08fe1412fc17.html +dir_f3d39c87bc262720c50d5e3885667b8a.html +dir_f76977d9ffe8ddf3ad01f3d689aa5df4.html +dir_ce36ac18ad3deaf5eae0bd2e09775a7d.html +dir_376a8598cfd3d58455c161124a3e8051.html +dir_7962cac16a99e8bbaaea18abede03fcb.html +dir_0726b97e666c2e7f518aadd1fe5118dc.html +dir_c918e8bf3fc71f849978cdb0d900e61c.html +dir_d28a4824dc47e487b107a5db32ef43c4.html +index.html +pages.html +annotated.html +classes.html +hierarchy.html +functions.html +functions_func.html +files.html +globals.html +globals_func.html +examples.html +tab_a.png +tab_b.png +tab_h.png +tab_s.png +nav_h.png +nav_f.png +bc_s.png +doxygen.png +closed.png +open.png +bdwn.png +sync_on.png +sync_off.png +ITEAD-logo.JPG +ftv2blank.png +ftv2doc.png +ftv2folderclosed.png +ftv2folderopen.png +ftv2lastnode.png +ftv2link.png +ftv2mlastnode.png +ftv2mnode.png +ftv2node.png +ftv2plastnode.png +ftv2pnode.png +ftv2vertline.png +ftv2splitbar.png +class_nex_button.png +class_nex_hotspot.png +class_nex_page.png +class_nex_picture.png +class_nex_pointer.png +class_nex_progress_bar.png +class_nex_slice.png +class_nex_text.png +class_nex_touch.png diff --git a/doc/API-html/index.html b/doc/API-html/index.html new file mode 100644 index 00000000..ca07b2f --- /dev/null +++ b/doc/API-html/index.html @@ -0,0 +1,54 @@ + + + + + + +API: Main Page + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + +
+
+
+
API Documentation
+
+
+
+ + + + diff --git a/doc/API-html/jquery.js b/doc/API-html/jquery.js new file mode 100644 index 00000000..6aa2e4c --- /dev/null +++ b/doc/API-html/jquery.js @@ -0,0 +1,39 @@ +/*! + * jQuery JavaScript Library v1.7.1 + * http://jquery.com/ + * + * Copyright 2011, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Mon Nov 21 21:11:03 2011 -0500 + */ +(function(bb,L){var av=bb.document,bu=bb.navigator,bl=bb.location;var b=(function(){var bF=function(b0,b1){return new bF.fn.init(b0,b1,bD)},bU=bb.jQuery,bH=bb.$,bD,bY=/^(?:[^#<]*(<[\w\W]+>)[^>]*$|#([\w\-]*)$)/,bM=/\S/,bI=/^\s+/,bE=/\s+$/,bA=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,bN=/^[\],:{}\s]*$/,bW=/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g,bP=/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g,bJ=/(?:^|:|,)(?:\s*\[)+/g,by=/(webkit)[ \/]([\w.]+)/,bR=/(opera)(?:.*version)?[ \/]([\w.]+)/,bQ=/(msie) ([\w.]+)/,bS=/(mozilla)(?:.*? rv:([\w.]+))?/,bB=/-([a-z]|[0-9])/ig,bZ=/^-ms-/,bT=function(b0,b1){return(b1+"").toUpperCase()},bX=bu.userAgent,bV,bC,e,bL=Object.prototype.toString,bG=Object.prototype.hasOwnProperty,bz=Array.prototype.push,bK=Array.prototype.slice,bO=String.prototype.trim,bv=Array.prototype.indexOf,bx={};bF.fn=bF.prototype={constructor:bF,init:function(b0,b4,b3){var b2,b5,b1,b6;if(!b0){return this}if(b0.nodeType){this.context=this[0]=b0;this.length=1;return this}if(b0==="body"&&!b4&&av.body){this.context=av;this[0]=av.body;this.selector=b0;this.length=1;return this}if(typeof b0==="string"){if(b0.charAt(0)==="<"&&b0.charAt(b0.length-1)===">"&&b0.length>=3){b2=[null,b0,null]}else{b2=bY.exec(b0)}if(b2&&(b2[1]||!b4)){if(b2[1]){b4=b4 instanceof bF?b4[0]:b4;b6=(b4?b4.ownerDocument||b4:av);b1=bA.exec(b0);if(b1){if(bF.isPlainObject(b4)){b0=[av.createElement(b1[1])];bF.fn.attr.call(b0,b4,true)}else{b0=[b6.createElement(b1[1])]}}else{b1=bF.buildFragment([b2[1]],[b6]);b0=(b1.cacheable?bF.clone(b1.fragment):b1.fragment).childNodes}return bF.merge(this,b0)}else{b5=av.getElementById(b2[2]);if(b5&&b5.parentNode){if(b5.id!==b2[2]){return b3.find(b0)}this.length=1;this[0]=b5}this.context=av;this.selector=b0;return this}}else{if(!b4||b4.jquery){return(b4||b3).find(b0)}else{return this.constructor(b4).find(b0)}}}else{if(bF.isFunction(b0)){return b3.ready(b0)}}if(b0.selector!==L){this.selector=b0.selector;this.context=b0.context}return bF.makeArray(b0,this)},selector:"",jquery:"1.7.1",length:0,size:function(){return this.length},toArray:function(){return bK.call(this,0)},get:function(b0){return b0==null?this.toArray():(b0<0?this[this.length+b0]:this[b0])},pushStack:function(b1,b3,b0){var b2=this.constructor();if(bF.isArray(b1)){bz.apply(b2,b1)}else{bF.merge(b2,b1)}b2.prevObject=this;b2.context=this.context;if(b3==="find"){b2.selector=this.selector+(this.selector?" ":"")+b0}else{if(b3){b2.selector=this.selector+"."+b3+"("+b0+")"}}return b2},each:function(b1,b0){return bF.each(this,b1,b0)},ready:function(b0){bF.bindReady();bC.add(b0);return this},eq:function(b0){b0=+b0;return b0===-1?this.slice(b0):this.slice(b0,b0+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(bK.apply(this,arguments),"slice",bK.call(arguments).join(","))},map:function(b0){return this.pushStack(bF.map(this,function(b2,b1){return b0.call(b2,b1,b2)}))},end:function(){return this.prevObject||this.constructor(null)},push:bz,sort:[].sort,splice:[].splice};bF.fn.init.prototype=bF.fn;bF.extend=bF.fn.extend=function(){var b9,b2,b0,b1,b6,b7,b5=arguments[0]||{},b4=1,b3=arguments.length,b8=false;if(typeof b5==="boolean"){b8=b5;b5=arguments[1]||{};b4=2}if(typeof b5!=="object"&&!bF.isFunction(b5)){b5={}}if(b3===b4){b5=this;--b4}for(;b40){return}bC.fireWith(av,[bF]);if(bF.fn.trigger){bF(av).trigger("ready").off("ready")}}},bindReady:function(){if(bC){return}bC=bF.Callbacks("once memory");if(av.readyState==="complete"){return setTimeout(bF.ready,1)}if(av.addEventListener){av.addEventListener("DOMContentLoaded",e,false);bb.addEventListener("load",bF.ready,false)}else{if(av.attachEvent){av.attachEvent("onreadystatechange",e);bb.attachEvent("onload",bF.ready);var b0=false;try{b0=bb.frameElement==null}catch(b1){}if(av.documentElement.doScroll&&b0){bw()}}}},isFunction:function(b0){return bF.type(b0)==="function"},isArray:Array.isArray||function(b0){return bF.type(b0)==="array"},isWindow:function(b0){return b0&&typeof b0==="object"&&"setInterval" in b0},isNumeric:function(b0){return !isNaN(parseFloat(b0))&&isFinite(b0)},type:function(b0){return b0==null?String(b0):bx[bL.call(b0)]||"object"},isPlainObject:function(b2){if(!b2||bF.type(b2)!=="object"||b2.nodeType||bF.isWindow(b2)){return false}try{if(b2.constructor&&!bG.call(b2,"constructor")&&!bG.call(b2.constructor.prototype,"isPrototypeOf")){return false}}catch(b1){return false}var b0;for(b0 in b2){}return b0===L||bG.call(b2,b0)},isEmptyObject:function(b1){for(var b0 in b1){return false}return true},error:function(b0){throw new Error(b0)},parseJSON:function(b0){if(typeof b0!=="string"||!b0){return null}b0=bF.trim(b0);if(bb.JSON&&bb.JSON.parse){return bb.JSON.parse(b0)}if(bN.test(b0.replace(bW,"@").replace(bP,"]").replace(bJ,""))){return(new Function("return "+b0))()}bF.error("Invalid JSON: "+b0)},parseXML:function(b2){var b0,b1;try{if(bb.DOMParser){b1=new DOMParser();b0=b1.parseFromString(b2,"text/xml")}else{b0=new ActiveXObject("Microsoft.XMLDOM");b0.async="false";b0.loadXML(b2)}}catch(b3){b0=L}if(!b0||!b0.documentElement||b0.getElementsByTagName("parsererror").length){bF.error("Invalid XML: "+b2)}return b0},noop:function(){},globalEval:function(b0){if(b0&&bM.test(b0)){(bb.execScript||function(b1){bb["eval"].call(bb,b1)})(b0)}},camelCase:function(b0){return b0.replace(bZ,"ms-").replace(bB,bT)},nodeName:function(b1,b0){return b1.nodeName&&b1.nodeName.toUpperCase()===b0.toUpperCase()},each:function(b3,b6,b2){var b1,b4=0,b5=b3.length,b0=b5===L||bF.isFunction(b3);if(b2){if(b0){for(b1 in b3){if(b6.apply(b3[b1],b2)===false){break}}}else{for(;b40&&b0[0]&&b0[b1-1])||b1===0||bF.isArray(b0));if(b3){for(;b21?aJ.call(arguments,0):bG;if(!(--bw)){bC.resolveWith(bC,bx)}}}function bz(bF){return function(bG){bB[bF]=arguments.length>1?aJ.call(arguments,0):bG;bC.notifyWith(bE,bB)}}if(e>1){for(;bv
a";bI=bv.getElementsByTagName("*");bF=bv.getElementsByTagName("a")[0];if(!bI||!bI.length||!bF){return{}}bG=av.createElement("select");bx=bG.appendChild(av.createElement("option"));bE=bv.getElementsByTagName("input")[0];bJ={leadingWhitespace:(bv.firstChild.nodeType===3),tbody:!bv.getElementsByTagName("tbody").length,htmlSerialize:!!bv.getElementsByTagName("link").length,style:/top/.test(bF.getAttribute("style")),hrefNormalized:(bF.getAttribute("href")==="/a"),opacity:/^0.55/.test(bF.style.opacity),cssFloat:!!bF.style.cssFloat,checkOn:(bE.value==="on"),optSelected:bx.selected,getSetAttribute:bv.className!=="t",enctype:!!av.createElement("form").enctype,html5Clone:av.createElement("nav").cloneNode(true).outerHTML!=="<:nav>",submitBubbles:true,changeBubbles:true,focusinBubbles:false,deleteExpando:true,noCloneEvent:true,inlineBlockNeedsLayout:false,shrinkWrapBlocks:false,reliableMarginRight:true};bE.checked=true;bJ.noCloneChecked=bE.cloneNode(true).checked;bG.disabled=true;bJ.optDisabled=!bx.disabled;try{delete bv.test}catch(bC){bJ.deleteExpando=false}if(!bv.addEventListener&&bv.attachEvent&&bv.fireEvent){bv.attachEvent("onclick",function(){bJ.noCloneEvent=false});bv.cloneNode(true).fireEvent("onclick")}bE=av.createElement("input");bE.value="t";bE.setAttribute("type","radio");bJ.radioValue=bE.value==="t";bE.setAttribute("checked","checked");bv.appendChild(bE);bD=av.createDocumentFragment();bD.appendChild(bv.lastChild);bJ.checkClone=bD.cloneNode(true).cloneNode(true).lastChild.checked;bJ.appendChecked=bE.checked;bD.removeChild(bE);bD.appendChild(bv);bv.innerHTML="";if(bb.getComputedStyle){bA=av.createElement("div");bA.style.width="0";bA.style.marginRight="0";bv.style.width="2px";bv.appendChild(bA);bJ.reliableMarginRight=(parseInt((bb.getComputedStyle(bA,null)||{marginRight:0}).marginRight,10)||0)===0}if(bv.attachEvent){for(by in {submit:1,change:1,focusin:1}){bB="on"+by;bw=(bB in bv);if(!bw){bv.setAttribute(bB,"return;");bw=(typeof bv[bB]==="function")}bJ[by+"Bubbles"]=bw}}bD.removeChild(bv);bD=bG=bx=bA=bv=bE=null;b(function(){var bM,bU,bV,bT,bN,bO,bL,bS,bR,e,bP,bQ=av.getElementsByTagName("body")[0];if(!bQ){return}bL=1;bS="position:absolute;top:0;left:0;width:1px;height:1px;margin:0;";bR="visibility:hidden;border:0;";e="style='"+bS+"border:5px solid #000;padding:0;'";bP="
";bM=av.createElement("div");bM.style.cssText=bR+"width:0;height:0;position:static;top:0;margin-top:"+bL+"px";bQ.insertBefore(bM,bQ.firstChild);bv=av.createElement("div");bM.appendChild(bv);bv.innerHTML="
t
";bz=bv.getElementsByTagName("td");bw=(bz[0].offsetHeight===0);bz[0].style.display="";bz[1].style.display="none";bJ.reliableHiddenOffsets=bw&&(bz[0].offsetHeight===0);bv.innerHTML="";bv.style.width=bv.style.paddingLeft="1px";b.boxModel=bJ.boxModel=bv.offsetWidth===2;if(typeof bv.style.zoom!=="undefined"){bv.style.display="inline";bv.style.zoom=1;bJ.inlineBlockNeedsLayout=(bv.offsetWidth===2);bv.style.display="";bv.innerHTML="
";bJ.shrinkWrapBlocks=(bv.offsetWidth!==2)}bv.style.cssText=bS+bR;bv.innerHTML=bP;bU=bv.firstChild;bV=bU.firstChild;bN=bU.nextSibling.firstChild.firstChild;bO={doesNotAddBorder:(bV.offsetTop!==5),doesAddBorderForTableAndCells:(bN.offsetTop===5)};bV.style.position="fixed";bV.style.top="20px";bO.fixedPosition=(bV.offsetTop===20||bV.offsetTop===15);bV.style.position=bV.style.top="";bU.style.overflow="hidden";bU.style.position="relative";bO.subtractsBorderForOverflowNotVisible=(bV.offsetTop===-5);bO.doesNotIncludeMarginInBodyOffset=(bQ.offsetTop!==bL);bQ.removeChild(bM);bv=bM=null;b.extend(bJ,bO)});return bJ})();var aS=/^(?:\{.*\}|\[.*\])$/,aA=/([A-Z])/g;b.extend({cache:{},uuid:0,expando:"jQuery"+(b.fn.jquery+Math.random()).replace(/\D/g,""),noData:{embed:true,object:"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000",applet:true},hasData:function(e){e=e.nodeType?b.cache[e[b.expando]]:e[b.expando];return !!e&&!S(e)},data:function(bx,bv,bz,by){if(!b.acceptData(bx)){return}var bG,bA,bD,bE=b.expando,bC=typeof bv==="string",bF=bx.nodeType,e=bF?b.cache:bx,bw=bF?bx[bE]:bx[bE]&&bE,bB=bv==="events";if((!bw||!e[bw]||(!bB&&!by&&!e[bw].data))&&bC&&bz===L){return}if(!bw){if(bF){bx[bE]=bw=++b.uuid}else{bw=bE}}if(!e[bw]){e[bw]={};if(!bF){e[bw].toJSON=b.noop}}if(typeof bv==="object"||typeof bv==="function"){if(by){e[bw]=b.extend(e[bw],bv)}else{e[bw].data=b.extend(e[bw].data,bv)}}bG=bA=e[bw];if(!by){if(!bA.data){bA.data={}}bA=bA.data}if(bz!==L){bA[b.camelCase(bv)]=bz}if(bB&&!bA[bv]){return bG.events}if(bC){bD=bA[bv];if(bD==null){bD=bA[b.camelCase(bv)]}}else{bD=bA}return bD},removeData:function(bx,bv,by){if(!b.acceptData(bx)){return}var bB,bA,bz,bC=b.expando,bD=bx.nodeType,e=bD?b.cache:bx,bw=bD?bx[bC]:bC;if(!e[bw]){return}if(bv){bB=by?e[bw]:e[bw].data;if(bB){if(!b.isArray(bv)){if(bv in bB){bv=[bv]}else{bv=b.camelCase(bv);if(bv in bB){bv=[bv]}else{bv=bv.split(" ")}}}for(bA=0,bz=bv.length;bA-1){return true}}return false},val:function(bx){var e,bv,by,bw=this[0];if(!arguments.length){if(bw){e=b.valHooks[bw.nodeName.toLowerCase()]||b.valHooks[bw.type];if(e&&"get" in e&&(bv=e.get(bw,"value"))!==L){return bv}bv=bw.value;return typeof bv==="string"?bv.replace(aU,""):bv==null?"":bv}return}by=b.isFunction(bx);return this.each(function(bA){var bz=b(this),bB;if(this.nodeType!==1){return}if(by){bB=bx.call(this,bA,bz.val())}else{bB=bx}if(bB==null){bB=""}else{if(typeof bB==="number"){bB+=""}else{if(b.isArray(bB)){bB=b.map(bB,function(bC){return bC==null?"":bC+""})}}}e=b.valHooks[this.nodeName.toLowerCase()]||b.valHooks[this.type];if(!e||!("set" in e)||e.set(this,bB,"value")===L){this.value=bB}})}});b.extend({valHooks:{option:{get:function(e){var bv=e.attributes.value;return !bv||bv.specified?e.value:e.text}},select:{get:function(e){var bA,bv,bz,bx,by=e.selectedIndex,bB=[],bC=e.options,bw=e.type==="select-one";if(by<0){return null}bv=bw?by:0;bz=bw?by+1:bC.length;for(;bv=0});if(!e.length){bv.selectedIndex=-1}return e}}},attrFn:{val:true,css:true,html:true,text:true,data:true,width:true,height:true,offset:true},attr:function(bA,bx,bB,bz){var bw,e,by,bv=bA.nodeType; +if(!bA||bv===3||bv===8||bv===2){return}if(bz&&bx in b.attrFn){return b(bA)[bx](bB)}if(typeof bA.getAttribute==="undefined"){return b.prop(bA,bx,bB)}by=bv!==1||!b.isXMLDoc(bA);if(by){bx=bx.toLowerCase();e=b.attrHooks[bx]||(ao.test(bx)?aY:be)}if(bB!==L){if(bB===null){b.removeAttr(bA,bx);return}else{if(e&&"set" in e&&by&&(bw=e.set(bA,bB,bx))!==L){return bw}else{bA.setAttribute(bx,""+bB);return bB}}}else{if(e&&"get" in e&&by&&(bw=e.get(bA,bx))!==null){return bw}else{bw=bA.getAttribute(bx);return bw===null?L:bw}}},removeAttr:function(bx,bz){var by,bA,bv,e,bw=0;if(bz&&bx.nodeType===1){bA=bz.toLowerCase().split(af);e=bA.length;for(;bw=0)}}})});var bd=/^(?:textarea|input|select)$/i,n=/^([^\.]*)?(?:\.(.+))?$/,J=/\bhover(\.\S+)?\b/,aO=/^key/,bf=/^(?:mouse|contextmenu)|click/,T=/^(?:focusinfocus|focusoutblur)$/,U=/^(\w*)(?:#([\w\-]+))?(?:\.([\w\-]+))?$/,Y=function(e){var bv=U.exec(e);if(bv){bv[1]=(bv[1]||"").toLowerCase();bv[3]=bv[3]&&new RegExp("(?:^|\\s)"+bv[3]+"(?:\\s|$)")}return bv},j=function(bw,e){var bv=bw.attributes||{};return((!e[1]||bw.nodeName.toLowerCase()===e[1])&&(!e[2]||(bv.id||{}).value===e[2])&&(!e[3]||e[3].test((bv["class"]||{}).value)))},bt=function(e){return b.event.special.hover?e:e.replace(J,"mouseenter$1 mouseleave$1")};b.event={add:function(bx,bC,bJ,bA,by){var bD,bB,bK,bI,bH,bF,e,bG,bv,bz,bw,bE;if(bx.nodeType===3||bx.nodeType===8||!bC||!bJ||!(bD=b._data(bx))){return}if(bJ.handler){bv=bJ;bJ=bv.handler}if(!bJ.guid){bJ.guid=b.guid++}bK=bD.events;if(!bK){bD.events=bK={}}bB=bD.handle;if(!bB){bD.handle=bB=function(bL){return typeof b!=="undefined"&&(!bL||b.event.triggered!==bL.type)?b.event.dispatch.apply(bB.elem,arguments):L};bB.elem=bx}bC=b.trim(bt(bC)).split(" ");for(bI=0;bI=0){bG=bG.slice(0,-1);bw=true}if(bG.indexOf(".")>=0){bx=bG.split(".");bG=bx.shift();bx.sort()}if((!bA||b.event.customEvent[bG])&&!b.event.global[bG]){return}bv=typeof bv==="object"?bv[b.expando]?bv:new b.Event(bG,bv):new b.Event(bG);bv.type=bG;bv.isTrigger=true;bv.exclusive=bw;bv.namespace=bx.join(".");bv.namespace_re=bv.namespace?new RegExp("(^|\\.)"+bx.join("\\.(?:.*\\.)?")+"(\\.|$)"):null;by=bG.indexOf(":")<0?"on"+bG:"";if(!bA){e=b.cache;for(bC in e){if(e[bC].events&&e[bC].events[bG]){b.event.trigger(bv,bD,e[bC].handle.elem,true)}}return}bv.result=L;if(!bv.target){bv.target=bA}bD=bD!=null?b.makeArray(bD):[];bD.unshift(bv);bF=b.event.special[bG]||{};if(bF.trigger&&bF.trigger.apply(bA,bD)===false){return}bB=[[bA,bF.bindType||bG]];if(!bJ&&!bF.noBubble&&!b.isWindow(bA)){bI=bF.delegateType||bG;bH=T.test(bI+bG)?bA:bA.parentNode;bz=null;for(;bH;bH=bH.parentNode){bB.push([bH,bI]);bz=bH}if(bz&&bz===bA.ownerDocument){bB.push([bz.defaultView||bz.parentWindow||bb,bI])}}for(bC=0;bCbA){bH.push({elem:this,matches:bz.slice(bA)})}for(bC=0;bC0?this.on(e,null,bx,bw):this.trigger(e)};if(b.attrFn){b.attrFn[e]=true}if(aO.test(e)){b.event.fixHooks[e]=b.event.keyHooks}if(bf.test(e)){b.event.fixHooks[e]=b.event.mouseHooks}}); +/*! + * Sizzle CSS Selector Engine + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * More information: http://sizzlejs.com/ + */ +(function(){var bH=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^\[\]]*\]|['"][^'"]*['"]|[^\[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g,bC="sizcache"+(Math.random()+"").replace(".",""),bI=0,bL=Object.prototype.toString,bB=false,bA=true,bK=/\\/g,bO=/\r\n/g,bQ=/\W/;[0,0].sort(function(){bA=false;return 0});var by=function(bV,e,bY,bZ){bY=bY||[];e=e||av;var b1=e;if(e.nodeType!==1&&e.nodeType!==9){return[]}if(!bV||typeof bV!=="string"){return bY}var bS,b3,b6,bR,b2,b5,b4,bX,bU=true,bT=by.isXML(e),bW=[],b0=bV;do{bH.exec("");bS=bH.exec(b0);if(bS){b0=bS[3];bW.push(bS[1]);if(bS[2]){bR=bS[3];break}}}while(bS);if(bW.length>1&&bD.exec(bV)){if(bW.length===2&&bE.relative[bW[0]]){b3=bM(bW[0]+bW[1],e,bZ)}else{b3=bE.relative[bW[0]]?[e]:by(bW.shift(),e);while(bW.length){bV=bW.shift();if(bE.relative[bV]){bV+=bW.shift()}b3=bM(bV,b3,bZ)}}}else{if(!bZ&&bW.length>1&&e.nodeType===9&&!bT&&bE.match.ID.test(bW[0])&&!bE.match.ID.test(bW[bW.length-1])){b2=by.find(bW.shift(),e,bT);e=b2.expr?by.filter(b2.expr,b2.set)[0]:b2.set[0]}if(e){b2=bZ?{expr:bW.pop(),set:bF(bZ)}:by.find(bW.pop(),bW.length===1&&(bW[0]==="~"||bW[0]==="+")&&e.parentNode?e.parentNode:e,bT);b3=b2.expr?by.filter(b2.expr,b2.set):b2.set;if(bW.length>0){b6=bF(b3)}else{bU=false}while(bW.length){b5=bW.pop();b4=b5;if(!bE.relative[b5]){b5=""}else{b4=bW.pop()}if(b4==null){b4=e}bE.relative[b5](b6,b4,bT)}}else{b6=bW=[]}}if(!b6){b6=b3}if(!b6){by.error(b5||bV)}if(bL.call(b6)==="[object Array]"){if(!bU){bY.push.apply(bY,b6)}else{if(e&&e.nodeType===1){for(bX=0;b6[bX]!=null;bX++){if(b6[bX]&&(b6[bX]===true||b6[bX].nodeType===1&&by.contains(e,b6[bX]))){bY.push(b3[bX])}}}else{for(bX=0;b6[bX]!=null;bX++){if(b6[bX]&&b6[bX].nodeType===1){bY.push(b3[bX])}}}}}else{bF(b6,bY)}if(bR){by(bR,b1,bY,bZ);by.uniqueSort(bY)}return bY};by.uniqueSort=function(bR){if(bJ){bB=bA;bR.sort(bJ);if(bB){for(var e=1;e0};by.find=function(bX,e,bY){var bW,bS,bU,bT,bV,bR;if(!bX){return[]}for(bS=0,bU=bE.order.length;bS":function(bW,bR){var bV,bU=typeof bR==="string",bS=0,e=bW.length;if(bU&&!bQ.test(bR)){bR=bR.toLowerCase();for(;bS=0)){if(!bS){e.push(bV)}}else{if(bS){bR[bU]=false}}}}return false},ID:function(e){return e[1].replace(bK,"")},TAG:function(bR,e){return bR[1].replace(bK,"").toLowerCase()},CHILD:function(e){if(e[1]==="nth"){if(!e[2]){by.error(e[0])}e[2]=e[2].replace(/^\+|\s*/g,"");var bR=/(-?)(\d*)(?:n([+\-]?\d*))?/.exec(e[2]==="even"&&"2n"||e[2]==="odd"&&"2n+1"||!/\D/.test(e[2])&&"0n+"+e[2]||e[2]);e[2]=(bR[1]+(bR[2]||1))-0;e[3]=bR[3]-0}else{if(e[2]){by.error(e[0])}}e[0]=bI++;return e},ATTR:function(bU,bR,bS,e,bV,bW){var bT=bU[1]=bU[1].replace(bK,"");if(!bW&&bE.attrMap[bT]){bU[1]=bE.attrMap[bT]}bU[4]=(bU[4]||bU[5]||"").replace(bK,"");if(bU[2]==="~="){bU[4]=" "+bU[4]+" "}return bU},PSEUDO:function(bU,bR,bS,e,bV){if(bU[1]==="not"){if((bH.exec(bU[3])||"").length>1||/^\w/.test(bU[3])){bU[3]=by(bU[3],null,null,bR)}else{var bT=by.filter(bU[3],bR,bS,true^bV);if(!bS){e.push.apply(e,bT)}return false}}else{if(bE.match.POS.test(bU[0])||bE.match.CHILD.test(bU[0])){return true}}return bU},POS:function(e){e.unshift(true);return e}},filters:{enabled:function(e){return e.disabled===false&&e.type!=="hidden"},disabled:function(e){return e.disabled===true},checked:function(e){return e.checked===true},selected:function(e){if(e.parentNode){e.parentNode.selectedIndex}return e.selected===true},parent:function(e){return !!e.firstChild},empty:function(e){return !e.firstChild},has:function(bS,bR,e){return !!by(e[3],bS).length},header:function(e){return(/h\d/i).test(e.nodeName)},text:function(bS){var e=bS.getAttribute("type"),bR=bS.type;return bS.nodeName.toLowerCase()==="input"&&"text"===bR&&(e===bR||e===null)},radio:function(e){return e.nodeName.toLowerCase()==="input"&&"radio"===e.type},checkbox:function(e){return e.nodeName.toLowerCase()==="input"&&"checkbox"===e.type},file:function(e){return e.nodeName.toLowerCase()==="input"&&"file"===e.type},password:function(e){return e.nodeName.toLowerCase()==="input"&&"password"===e.type},submit:function(bR){var e=bR.nodeName.toLowerCase();return(e==="input"||e==="button")&&"submit"===bR.type},image:function(e){return e.nodeName.toLowerCase()==="input"&&"image"===e.type},reset:function(bR){var e=bR.nodeName.toLowerCase();return(e==="input"||e==="button")&&"reset"===bR.type},button:function(bR){var e=bR.nodeName.toLowerCase();return e==="input"&&"button"===bR.type||e==="button"},input:function(e){return(/input|select|textarea|button/i).test(e.nodeName)},focus:function(e){return e===e.ownerDocument.activeElement}},setFilters:{first:function(bR,e){return e===0},last:function(bS,bR,e,bT){return bR===bT.length-1},even:function(bR,e){return e%2===0},odd:function(bR,e){return e%2===1 +},lt:function(bS,bR,e){return bRe[3]-0},nth:function(bS,bR,e){return e[3]-0===bR},eq:function(bS,bR,e){return e[3]-0===bR}},filter:{PSEUDO:function(bS,bX,bW,bY){var e=bX[1],bR=bE.filters[e];if(bR){return bR(bS,bW,bX,bY)}else{if(e==="contains"){return(bS.textContent||bS.innerText||bw([bS])||"").indexOf(bX[3])>=0}else{if(e==="not"){var bT=bX[3];for(var bV=0,bU=bT.length;bV=0)}}},ID:function(bR,e){return bR.nodeType===1&&bR.getAttribute("id")===e},TAG:function(bR,e){return(e==="*"&&bR.nodeType===1)||!!bR.nodeName&&bR.nodeName.toLowerCase()===e},CLASS:function(bR,e){return(" "+(bR.className||bR.getAttribute("class"))+" ").indexOf(e)>-1},ATTR:function(bV,bT){var bS=bT[1],e=by.attr?by.attr(bV,bS):bE.attrHandle[bS]?bE.attrHandle[bS](bV):bV[bS]!=null?bV[bS]:bV.getAttribute(bS),bW=e+"",bU=bT[2],bR=bT[4];return e==null?bU==="!=":!bU&&by.attr?e!=null:bU==="="?bW===bR:bU==="*="?bW.indexOf(bR)>=0:bU==="~="?(" "+bW+" ").indexOf(bR)>=0:!bR?bW&&e!==false:bU==="!="?bW!==bR:bU==="^="?bW.indexOf(bR)===0:bU==="$="?bW.substr(bW.length-bR.length)===bR:bU==="|="?bW===bR||bW.substr(0,bR.length+1)===bR+"-":false},POS:function(bU,bR,bS,bV){var e=bR[2],bT=bE.setFilters[e];if(bT){return bT(bU,bS,bR,bV)}}}};var bD=bE.match.POS,bx=function(bR,e){return"\\"+(e-0+1)};for(var bz in bE.match){bE.match[bz]=new RegExp(bE.match[bz].source+(/(?![^\[]*\])(?![^\(]*\))/.source));bE.leftMatch[bz]=new RegExp(/(^(?:.|\r|\n)*?)/.source+bE.match[bz].source.replace(/\\(\d+)/g,bx))}var bF=function(bR,e){bR=Array.prototype.slice.call(bR,0);if(e){e.push.apply(e,bR);return e}return bR};try{Array.prototype.slice.call(av.documentElement.childNodes,0)[0].nodeType}catch(bP){bF=function(bU,bT){var bS=0,bR=bT||[];if(bL.call(bU)==="[object Array]"){Array.prototype.push.apply(bR,bU)}else{if(typeof bU.length==="number"){for(var e=bU.length;bS";e.insertBefore(bR,e.firstChild);if(av.getElementById(bS)){bE.find.ID=function(bU,bV,bW){if(typeof bV.getElementById!=="undefined"&&!bW){var bT=bV.getElementById(bU[1]);return bT?bT.id===bU[1]||typeof bT.getAttributeNode!=="undefined"&&bT.getAttributeNode("id").nodeValue===bU[1]?[bT]:L:[]}};bE.filter.ID=function(bV,bT){var bU=typeof bV.getAttributeNode!=="undefined"&&bV.getAttributeNode("id");return bV.nodeType===1&&bU&&bU.nodeValue===bT}}e.removeChild(bR);e=bR=null})();(function(){var e=av.createElement("div");e.appendChild(av.createComment(""));if(e.getElementsByTagName("*").length>0){bE.find.TAG=function(bR,bV){var bU=bV.getElementsByTagName(bR[1]);if(bR[1]==="*"){var bT=[];for(var bS=0;bU[bS];bS++){if(bU[bS].nodeType===1){bT.push(bU[bS])}}bU=bT}return bU}}e.innerHTML="";if(e.firstChild&&typeof e.firstChild.getAttribute!=="undefined"&&e.firstChild.getAttribute("href")!=="#"){bE.attrHandle.href=function(bR){return bR.getAttribute("href",2)}}e=null})();if(av.querySelectorAll){(function(){var e=by,bT=av.createElement("div"),bS="__sizzle__";bT.innerHTML="

";if(bT.querySelectorAll&&bT.querySelectorAll(".TEST").length===0){return}by=function(b4,bV,bZ,b3){bV=bV||av;if(!b3&&!by.isXML(bV)){var b2=/^(\w+$)|^\.([\w\-]+$)|^#([\w\-]+$)/.exec(b4);if(b2&&(bV.nodeType===1||bV.nodeType===9)){if(b2[1]){return bF(bV.getElementsByTagName(b4),bZ)}else{if(b2[2]&&bE.find.CLASS&&bV.getElementsByClassName){return bF(bV.getElementsByClassName(b2[2]),bZ)}}}if(bV.nodeType===9){if(b4==="body"&&bV.body){return bF([bV.body],bZ)}else{if(b2&&b2[3]){var bY=bV.getElementById(b2[3]);if(bY&&bY.parentNode){if(bY.id===b2[3]){return bF([bY],bZ)}}else{return bF([],bZ)}}}try{return bF(bV.querySelectorAll(b4),bZ)}catch(b0){}}else{if(bV.nodeType===1&&bV.nodeName.toLowerCase()!=="object"){var bW=bV,bX=bV.getAttribute("id"),bU=bX||bS,b6=bV.parentNode,b5=/^\s*[+~]/.test(b4);if(!bX){bV.setAttribute("id",bU)}else{bU=bU.replace(/'/g,"\\$&")}if(b5&&b6){bV=bV.parentNode}try{if(!b5||b6){return bF(bV.querySelectorAll("[id='"+bU+"'] "+b4),bZ)}}catch(b1){}finally{if(!bX){bW.removeAttribute("id")}}}}}return e(b4,bV,bZ,b3)};for(var bR in e){by[bR]=e[bR]}bT=null})()}(function(){var e=av.documentElement,bS=e.matchesSelector||e.mozMatchesSelector||e.webkitMatchesSelector||e.msMatchesSelector;if(bS){var bU=!bS.call(av.createElement("div"),"div"),bR=false;try{bS.call(av.documentElement,"[test!='']:sizzle")}catch(bT){bR=true}by.matchesSelector=function(bW,bY){bY=bY.replace(/\=\s*([^'"\]]*)\s*\]/g,"='$1']");if(!by.isXML(bW)){try{if(bR||!bE.match.PSEUDO.test(bY)&&!/!=/.test(bY)){var bV=bS.call(bW,bY);if(bV||!bU||bW.document&&bW.document.nodeType!==11){return bV}}}catch(bX){}}return by(bY,null,null,[bW]).length>0}}})();(function(){var e=av.createElement("div");e.innerHTML="
";if(!e.getElementsByClassName||e.getElementsByClassName("e").length===0){return}e.lastChild.className="e";if(e.getElementsByClassName("e").length===1){return}bE.order.splice(1,0,"CLASS");bE.find.CLASS=function(bR,bS,bT){if(typeof bS.getElementsByClassName!=="undefined"&&!bT){return bS.getElementsByClassName(bR[1])}};e=null})();function bv(bR,bW,bV,bZ,bX,bY){for(var bT=0,bS=bZ.length;bT0){bU=e;break}}}e=e[bR]}bZ[bT]=bU}}}if(av.documentElement.contains){by.contains=function(bR,e){return bR!==e&&(bR.contains?bR.contains(e):true)}}else{if(av.documentElement.compareDocumentPosition){by.contains=function(bR,e){return !!(bR.compareDocumentPosition(e)&16)}}else{by.contains=function(){return false}}}by.isXML=function(e){var bR=(e?e.ownerDocument||e:0).documentElement;return bR?bR.nodeName!=="HTML":false};var bM=function(bS,e,bW){var bV,bX=[],bU="",bY=e.nodeType?[e]:e;while((bV=bE.match.PSEUDO.exec(bS))){bU+=bV[0];bS=bS.replace(bE.match.PSEUDO,"")}bS=bE.relative[bS]?bS+"*":bS;for(var bT=0,bR=bY.length;bT0){for(bB=bA;bB=0:b.filter(e,this).length>0:this.filter(e).length>0)},closest:function(by,bx){var bv=[],bw,e,bz=this[0];if(b.isArray(by)){var bB=1;while(bz&&bz.ownerDocument&&bz!==bx){for(bw=0;bw-1:b.find.matchesSelector(bz,by)){bv.push(bz);break}else{bz=bz.parentNode;if(!bz||!bz.ownerDocument||bz===bx||bz.nodeType===11){break}}}}bv=bv.length>1?b.unique(bv):bv;return this.pushStack(bv,"closest",by)},index:function(e){if(!e){return(this[0]&&this[0].parentNode)?this.prevAll().length:-1}if(typeof e==="string"){return b.inArray(this[0],b(e))}return b.inArray(e.jquery?e[0]:e,this)},add:function(e,bv){var bx=typeof e==="string"?b(e,bv):b.makeArray(e&&e.nodeType?[e]:e),bw=b.merge(this.get(),bx);return this.pushStack(C(bx[0])||C(bw[0])?bw:b.unique(bw))},andSelf:function(){return this.add(this.prevObject)}});function C(e){return !e||!e.parentNode||e.parentNode.nodeType===11}b.each({parent:function(bv){var e=bv.parentNode;return e&&e.nodeType!==11?e:null},parents:function(e){return b.dir(e,"parentNode")},parentsUntil:function(bv,e,bw){return b.dir(bv,"parentNode",bw)},next:function(e){return b.nth(e,2,"nextSibling")},prev:function(e){return b.nth(e,2,"previousSibling")},nextAll:function(e){return b.dir(e,"nextSibling")},prevAll:function(e){return b.dir(e,"previousSibling")},nextUntil:function(bv,e,bw){return b.dir(bv,"nextSibling",bw)},prevUntil:function(bv,e,bw){return b.dir(bv,"previousSibling",bw)},siblings:function(e){return b.sibling(e.parentNode.firstChild,e)},children:function(e){return b.sibling(e.firstChild)},contents:function(e){return b.nodeName(e,"iframe")?e.contentDocument||e.contentWindow.document:b.makeArray(e.childNodes)}},function(e,bv){b.fn[e]=function(by,bw){var bx=b.map(this,bv,by);if(!ab.test(e)){bw=by}if(bw&&typeof bw==="string"){bx=b.filter(bw,bx)}bx=this.length>1&&!ay[e]?b.unique(bx):bx;if((this.length>1||a9.test(bw))&&aq.test(e)){bx=bx.reverse()}return this.pushStack(bx,e,P.call(arguments).join(","))}});b.extend({filter:function(bw,e,bv){if(bv){bw=":not("+bw+")"}return e.length===1?b.find.matchesSelector(e[0],bw)?[e[0]]:[]:b.find.matches(bw,e)},dir:function(bw,bv,by){var e=[],bx=bw[bv];while(bx&&bx.nodeType!==9&&(by===L||bx.nodeType!==1||!b(bx).is(by))){if(bx.nodeType===1){e.push(bx)}bx=bx[bv]}return e},nth:function(by,e,bw,bx){e=e||1;var bv=0;for(;by;by=by[bw]){if(by.nodeType===1&&++bv===e){break}}return by},sibling:function(bw,bv){var e=[];for(;bw;bw=bw.nextSibling){if(bw.nodeType===1&&bw!==bv){e.push(bw)}}return e}});function aG(bx,bw,e){bw=bw||0;if(b.isFunction(bw)){return b.grep(bx,function(bz,by){var bA=!!bw.call(bz,by,bz);return bA===e})}else{if(bw.nodeType){return b.grep(bx,function(bz,by){return(bz===bw)===e})}else{if(typeof bw==="string"){var bv=b.grep(bx,function(by){return by.nodeType===1});if(bp.test(bw)){return b.filter(bw,bv,!e)}else{bw=b.filter(bw,bv)}}}}return b.grep(bx,function(bz,by){return(b.inArray(bz,bw)>=0)===e})}function a(e){var bw=aR.split("|"),bv=e.createDocumentFragment();if(bv.createElement){while(bw.length){bv.createElement(bw.pop())}}return bv}var aR="abbr|article|aside|audio|canvas|datalist|details|figcaption|figure|footer|header|hgroup|mark|meter|nav|output|progress|section|summary|time|video",ag=/ jQuery\d+="(?:\d+|null)"/g,ar=/^\s+/,R=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/ig,d=/<([\w:]+)/,w=/",""],legend:[1,"
","
"],thead:[1,"","
"],tr:[2,"","
"],td:[3,"","
"],col:[2,"","
"],area:[1,"",""],_default:[0,"",""]},ac=a(av); +ax.optgroup=ax.option;ax.tbody=ax.tfoot=ax.colgroup=ax.caption=ax.thead;ax.th=ax.td;if(!b.support.htmlSerialize){ax._default=[1,"div
","
"]}b.fn.extend({text:function(e){if(b.isFunction(e)){return this.each(function(bw){var bv=b(this);bv.text(e.call(this,bw,bv.text()))})}if(typeof e!=="object"&&e!==L){return this.empty().append((this[0]&&this[0].ownerDocument||av).createTextNode(e))}return b.text(this)},wrapAll:function(e){if(b.isFunction(e)){return this.each(function(bw){b(this).wrapAll(e.call(this,bw))})}if(this[0]){var bv=b(e,this[0].ownerDocument).eq(0).clone(true);if(this[0].parentNode){bv.insertBefore(this[0])}bv.map(function(){var bw=this;while(bw.firstChild&&bw.firstChild.nodeType===1){bw=bw.firstChild}return bw}).append(this)}return this},wrapInner:function(e){if(b.isFunction(e)){return this.each(function(bv){b(this).wrapInner(e.call(this,bv))})}return this.each(function(){var bv=b(this),bw=bv.contents();if(bw.length){bw.wrapAll(e)}else{bv.append(e)}})},wrap:function(e){var bv=b.isFunction(e);return this.each(function(bw){b(this).wrapAll(bv?e.call(this,bw):e)})},unwrap:function(){return this.parent().each(function(){if(!b.nodeName(this,"body")){b(this).replaceWith(this.childNodes)}}).end()},append:function(){return this.domManip(arguments,true,function(e){if(this.nodeType===1){this.appendChild(e)}})},prepend:function(){return this.domManip(arguments,true,function(e){if(this.nodeType===1){this.insertBefore(e,this.firstChild)}})},before:function(){if(this[0]&&this[0].parentNode){return this.domManip(arguments,false,function(bv){this.parentNode.insertBefore(bv,this)})}else{if(arguments.length){var e=b.clean(arguments);e.push.apply(e,this.toArray());return this.pushStack(e,"before",arguments)}}},after:function(){if(this[0]&&this[0].parentNode){return this.domManip(arguments,false,function(bv){this.parentNode.insertBefore(bv,this.nextSibling)})}else{if(arguments.length){var e=this.pushStack(this,"after",arguments);e.push.apply(e,b.clean(arguments));return e}}},remove:function(e,bx){for(var bv=0,bw;(bw=this[bv])!=null;bv++){if(!e||b.filter(e,[bw]).length){if(!bx&&bw.nodeType===1){b.cleanData(bw.getElementsByTagName("*"));b.cleanData([bw])}if(bw.parentNode){bw.parentNode.removeChild(bw)}}}return this},empty:function(){for(var e=0,bv;(bv=this[e])!=null;e++){if(bv.nodeType===1){b.cleanData(bv.getElementsByTagName("*"))}while(bv.firstChild){bv.removeChild(bv.firstChild)}}return this},clone:function(bv,e){bv=bv==null?false:bv;e=e==null?bv:e;return this.map(function(){return b.clone(this,bv,e)})},html:function(bx){if(bx===L){return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(ag,""):null}else{if(typeof bx==="string"&&!ae.test(bx)&&(b.support.leadingWhitespace||!ar.test(bx))&&!ax[(d.exec(bx)||["",""])[1].toLowerCase()]){bx=bx.replace(R,"<$1>");try{for(var bw=0,bv=this.length;bw1&&bw0?this.clone(true):this).get();b(bC[bA])[bv](by);bz=bz.concat(by)}return this.pushStack(bz,e,bC.selector)}}});function bg(e){if(typeof e.getElementsByTagName!=="undefined"){return e.getElementsByTagName("*")}else{if(typeof e.querySelectorAll!=="undefined"){return e.querySelectorAll("*")}else{return[]}}}function az(e){if(e.type==="checkbox"||e.type==="radio"){e.defaultChecked=e.checked}}function E(e){var bv=(e.nodeName||"").toLowerCase();if(bv==="input"){az(e)}else{if(bv!=="script"&&typeof e.getElementsByTagName!=="undefined"){b.grep(e.getElementsByTagName("input"),az)}}}function al(e){var bv=av.createElement("div");ac.appendChild(bv);bv.innerHTML=e.outerHTML;return bv.firstChild}b.extend({clone:function(by,bA,bw){var e,bv,bx,bz=b.support.html5Clone||!ah.test("<"+by.nodeName)?by.cloneNode(true):al(by);if((!b.support.noCloneEvent||!b.support.noCloneChecked)&&(by.nodeType===1||by.nodeType===11)&&!b.isXMLDoc(by)){ai(by,bz);e=bg(by);bv=bg(bz);for(bx=0;e[bx];++bx){if(bv[bx]){ai(e[bx],bv[bx])}}}if(bA){t(by,bz);if(bw){e=bg(by);bv=bg(bz);for(bx=0;e[bx];++bx){t(e[bx],bv[bx])}}}e=bv=null;return bz},clean:function(bw,by,bH,bA){var bF;by=by||av;if(typeof by.createElement==="undefined"){by=by.ownerDocument||by[0]&&by[0].ownerDocument||av}var bI=[],bB;for(var bE=0,bz;(bz=bw[bE])!=null;bE++){if(typeof bz==="number"){bz+=""}if(!bz){continue}if(typeof bz==="string"){if(!W.test(bz)){bz=by.createTextNode(bz)}else{bz=bz.replace(R,"<$1>");var bK=(d.exec(bz)||["",""])[1].toLowerCase(),bx=ax[bK]||ax._default,bD=bx[0],bv=by.createElement("div");if(by===av){ac.appendChild(bv)}else{a(by).appendChild(bv)}bv.innerHTML=bx[1]+bz+bx[2];while(bD--){bv=bv.lastChild}if(!b.support.tbody){var e=w.test(bz),bC=bK==="table"&&!e?bv.firstChild&&bv.firstChild.childNodes:bx[1]===""&&!e?bv.childNodes:[];for(bB=bC.length-1;bB>=0;--bB){if(b.nodeName(bC[bB],"tbody")&&!bC[bB].childNodes.length){bC[bB].parentNode.removeChild(bC[bB])}}}if(!b.support.leadingWhitespace&&ar.test(bz)){bv.insertBefore(by.createTextNode(ar.exec(bz)[0]),bv.firstChild)}bz=bv.childNodes}}var bG;if(!b.support.appendChecked){if(bz[0]&&typeof(bG=bz.length)==="number"){for(bB=0;bB=0){return bx+"px"}}else{return bx}}}});if(!b.support.opacity){b.cssHooks.opacity={get:function(bv,e){return au.test((e&&bv.currentStyle?bv.currentStyle.filter:bv.style.filter)||"")?(parseFloat(RegExp.$1)/100)+"":e?"1":""},set:function(by,bz){var bx=by.style,bv=by.currentStyle,e=b.isNumeric(bz)?"alpha(opacity="+bz*100+")":"",bw=bv&&bv.filter||bx.filter||"";bx.zoom=1;if(bz>=1&&b.trim(bw.replace(ak,""))===""){bx.removeAttribute("filter");if(bv&&!bv.filter){return}}bx.filter=ak.test(bw)?bw.replace(ak,e):bw+" "+e}}}b(function(){if(!b.support.reliableMarginRight){b.cssHooks.marginRight={get:function(bw,bv){var e;b.swap(bw,{display:"inline-block"},function(){if(bv){e=Z(bw,"margin-right","marginRight")}else{e=bw.style.marginRight}});return e}}}});if(av.defaultView&&av.defaultView.getComputedStyle){aI=function(by,bw){var bv,bx,e;bw=bw.replace(z,"-$1").toLowerCase();if((bx=by.ownerDocument.defaultView)&&(e=bx.getComputedStyle(by,null))){bv=e.getPropertyValue(bw);if(bv===""&&!b.contains(by.ownerDocument.documentElement,by)){bv=b.style(by,bw)}}return bv}}if(av.documentElement.currentStyle){aX=function(bz,bw){var bA,e,by,bv=bz.currentStyle&&bz.currentStyle[bw],bx=bz.style;if(bv===null&&bx&&(by=bx[bw])){bv=by}if(!bc.test(bv)&&bn.test(bv)){bA=bx.left;e=bz.runtimeStyle&&bz.runtimeStyle.left;if(e){bz.runtimeStyle.left=bz.currentStyle.left}bx.left=bw==="fontSize"?"1em":(bv||0);bv=bx.pixelLeft+"px";bx.left=bA;if(e){bz.runtimeStyle.left=e}}return bv===""?"auto":bv}}Z=aI||aX;function p(by,bw,bv){var bA=bw==="width"?by.offsetWidth:by.offsetHeight,bz=bw==="width"?an:a1,bx=0,e=bz.length; +if(bA>0){if(bv!=="border"){for(;bx)<[^<]*)*<\/script>/gi,q=/^(?:select|textarea)/i,h=/\s+/,br=/([?&])_=[^&]*/,K=/^([\w\+\.\-]+:)(?:\/\/([^\/?#:]*)(?::(\d+))?)?/,A=b.fn.load,aa={},r={},aE,s,aV=["*/"]+["*"];try{aE=bl.href}catch(aw){aE=av.createElement("a");aE.href="";aE=aE.href}s=K.exec(aE.toLowerCase())||[];function f(e){return function(by,bA){if(typeof by!=="string"){bA=by;by="*"}if(b.isFunction(bA)){var bx=by.toLowerCase().split(h),bw=0,bz=bx.length,bv,bB,bC;for(;bw=0){var e=bw.slice(by,bw.length);bw=bw.slice(0,by)}var bx="GET";if(bz){if(b.isFunction(bz)){bA=bz;bz=L}else{if(typeof bz==="object"){bz=b.param(bz,b.ajaxSettings.traditional);bx="POST"}}}var bv=this;b.ajax({url:bw,type:bx,dataType:"html",data:bz,complete:function(bC,bB,bD){bD=bC.responseText;if(bC.isResolved()){bC.done(function(bE){bD=bE});bv.html(e?b("
").append(bD.replace(a6,"")).find(e):bD)}if(bA){bv.each(bA,[bD,bB,bC])}}});return this},serialize:function(){return b.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?b.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||q.test(this.nodeName)||aZ.test(this.type))}).map(function(e,bv){var bw=b(this).val();return bw==null?null:b.isArray(bw)?b.map(bw,function(by,bx){return{name:bv.name,value:by.replace(bs,"\r\n")}}):{name:bv.name,value:bw.replace(bs,"\r\n")}}).get()}});b.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "),function(e,bv){b.fn[bv]=function(bw){return this.on(bv,bw)}});b.each(["get","post"],function(e,bv){b[bv]=function(bw,by,bz,bx){if(b.isFunction(by)){bx=bx||bz;bz=by;by=L}return b.ajax({type:bv,url:bw,data:by,success:bz,dataType:bx})}});b.extend({getScript:function(e,bv){return b.get(e,L,bv,"script")},getJSON:function(e,bv,bw){return b.get(e,bv,bw,"json")},ajaxSetup:function(bv,e){if(e){am(bv,b.ajaxSettings)}else{e=bv;bv=b.ajaxSettings}am(bv,e);return bv},ajaxSettings:{url:aE,isLocal:aM.test(s[1]),global:true,type:"GET",contentType:"application/x-www-form-urlencoded",processData:true,async:true,accepts:{xml:"application/xml, text/xml",html:"text/html",text:"text/plain",json:"application/json, text/javascript","*":aV},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText"},converters:{"* text":bb.String,"text html":true,"text json":b.parseJSON,"text xml":b.parseXML},flatOptions:{context:true,url:true}},ajaxPrefilter:f(aa),ajaxTransport:f(r),ajax:function(bz,bx){if(typeof bz==="object"){bx=bz;bz=L}bx=bx||{};var bD=b.ajaxSetup({},bx),bS=bD.context||bD,bG=bS!==bD&&(bS.nodeType||bS instanceof b)?b(bS):b.event,bR=b.Deferred(),bN=b.Callbacks("once memory"),bB=bD.statusCode||{},bC,bH={},bO={},bQ,by,bL,bE,bI,bA=0,bw,bK,bJ={readyState:0,setRequestHeader:function(bT,bU){if(!bA){var e=bT.toLowerCase();bT=bO[e]=bO[e]||bT;bH[bT]=bU}return this},getAllResponseHeaders:function(){return bA===2?bQ:null},getResponseHeader:function(bT){var e;if(bA===2){if(!by){by={};while((e=aD.exec(bQ))){by[e[1].toLowerCase()]=e[2]}}e=by[bT.toLowerCase()]}return e===L?null:e},overrideMimeType:function(e){if(!bA){bD.mimeType=e}return this},abort:function(e){e=e||"abort";if(bL){bL.abort(e)}bF(0,e);return this}};function bF(bZ,bU,b0,bW){if(bA===2){return}bA=2;if(bE){clearTimeout(bE)}bL=L;bQ=bW||"";bJ.readyState=bZ>0?4:0;var bT,b4,b3,bX=bU,bY=b0?bj(bD,bJ,b0):L,bV,b2;if(bZ>=200&&bZ<300||bZ===304){if(bD.ifModified){if((bV=bJ.getResponseHeader("Last-Modified"))){b.lastModified[bC]=bV}if((b2=bJ.getResponseHeader("Etag"))){b.etag[bC]=b2}}if(bZ===304){bX="notmodified";bT=true}else{try{b4=G(bD,bY);bX="success";bT=true}catch(b1){bX="parsererror";b3=b1}}}else{b3=bX;if(!bX||bZ){bX="error";if(bZ<0){bZ=0}}}bJ.status=bZ;bJ.statusText=""+(bU||bX);if(bT){bR.resolveWith(bS,[b4,bX,bJ])}else{bR.rejectWith(bS,[bJ,bX,b3])}bJ.statusCode(bB);bB=L;if(bw){bG.trigger("ajax"+(bT?"Success":"Error"),[bJ,bD,bT?b4:b3])}bN.fireWith(bS,[bJ,bX]);if(bw){bG.trigger("ajaxComplete",[bJ,bD]);if(!(--b.active)){b.event.trigger("ajaxStop")}}}bR.promise(bJ);bJ.success=bJ.done;bJ.error=bJ.fail;bJ.complete=bN.add;bJ.statusCode=function(bT){if(bT){var e;if(bA<2){for(e in bT){bB[e]=[bB[e],bT[e]]}}else{e=bT[bJ.status];bJ.then(e,e)}}return this};bD.url=((bz||bD.url)+"").replace(bq,"").replace(c,s[1]+"//");bD.dataTypes=b.trim(bD.dataType||"*").toLowerCase().split(h);if(bD.crossDomain==null){bI=K.exec(bD.url.toLowerCase());bD.crossDomain=!!(bI&&(bI[1]!=s[1]||bI[2]!=s[2]||(bI[3]||(bI[1]==="http:"?80:443))!=(s[3]||(s[1]==="http:"?80:443))))}if(bD.data&&bD.processData&&typeof bD.data!=="string"){bD.data=b.param(bD.data,bD.traditional)}aW(aa,bD,bx,bJ);if(bA===2){return false}bw=bD.global;bD.type=bD.type.toUpperCase();bD.hasContent=!aQ.test(bD.type);if(bw&&b.active++===0){b.event.trigger("ajaxStart")}if(!bD.hasContent){if(bD.data){bD.url+=(M.test(bD.url)?"&":"?")+bD.data;delete bD.data}bC=bD.url;if(bD.cache===false){var bv=b.now(),bP=bD.url.replace(br,"$1_="+bv);bD.url=bP+((bP===bD.url)?(M.test(bD.url)?"&":"?")+"_="+bv:"")}}if(bD.data&&bD.hasContent&&bD.contentType!==false||bx.contentType){bJ.setRequestHeader("Content-Type",bD.contentType)}if(bD.ifModified){bC=bC||bD.url;if(b.lastModified[bC]){bJ.setRequestHeader("If-Modified-Since",b.lastModified[bC])}if(b.etag[bC]){bJ.setRequestHeader("If-None-Match",b.etag[bC])}}bJ.setRequestHeader("Accept",bD.dataTypes[0]&&bD.accepts[bD.dataTypes[0]]?bD.accepts[bD.dataTypes[0]]+(bD.dataTypes[0]!=="*"?", "+aV+"; q=0.01":""):bD.accepts["*"]);for(bK in bD.headers){bJ.setRequestHeader(bK,bD.headers[bK])}if(bD.beforeSend&&(bD.beforeSend.call(bS,bJ,bD)===false||bA===2)){bJ.abort();return false}for(bK in {success:1,error:1,complete:1}){bJ[bK](bD[bK])}bL=aW(r,bD,bx,bJ);if(!bL){bF(-1,"No Transport")}else{bJ.readyState=1;if(bw){bG.trigger("ajaxSend",[bJ,bD])}if(bD.async&&bD.timeout>0){bE=setTimeout(function(){bJ.abort("timeout")},bD.timeout)}try{bA=1;bL.send(bH,bF)}catch(bM){if(bA<2){bF(-1,bM)}else{throw bM}}}return bJ},param:function(e,bw){var bv=[],by=function(bz,bA){bA=b.isFunction(bA)?bA():bA;bv[bv.length]=encodeURIComponent(bz)+"="+encodeURIComponent(bA)};if(bw===L){bw=b.ajaxSettings.traditional}if(b.isArray(e)||(e.jquery&&!b.isPlainObject(e))){b.each(e,function(){by(this.name,this.value)})}else{for(var bx in e){v(bx,e[bx],bw,by)}}return bv.join("&").replace(k,"+")}});function v(bw,by,bv,bx){if(b.isArray(by)){b.each(by,function(bA,bz){if(bv||ap.test(bw)){bx(bw,bz)}else{v(bw+"["+(typeof bz==="object"||b.isArray(bz)?bA:"")+"]",bz,bv,bx)}})}else{if(!bv&&by!=null&&typeof by==="object"){for(var e in by){v(bw+"["+e+"]",by[e],bv,bx)}}else{bx(bw,by)}}}b.extend({active:0,lastModified:{},etag:{}});function bj(bD,bC,bz){var bv=bD.contents,bB=bD.dataTypes,bw=bD.responseFields,by,bA,bx,e;for(bA in bw){if(bA in bz){bC[bw[bA]]=bz[bA]}}while(bB[0]==="*"){bB.shift();if(by===L){by=bD.mimeType||bC.getResponseHeader("content-type")}}if(by){for(bA in bv){if(bv[bA]&&bv[bA].test(by)){bB.unshift(bA);break}}}if(bB[0] in bz){bx=bB[0]}else{for(bA in bz){if(!bB[0]||bD.converters[bA+" "+bB[0]]){bx=bA;break}if(!e){e=bA}}bx=bx||e}if(bx){if(bx!==bB[0]){bB.unshift(bx)}return bz[bx]}}function G(bH,bz){if(bH.dataFilter){bz=bH.dataFilter(bz,bH.dataType)}var bD=bH.dataTypes,bG={},bA,bE,bw=bD.length,bB,bC=bD[0],bx,by,bF,bv,e;for(bA=1;bA=bw.duration+this.startTime){this.now=this.end;this.pos=this.state=1;this.update();bw.animatedProperties[this.prop]=true;for(bA in bw.animatedProperties){if(bw.animatedProperties[bA]!==true){e=false}}if(e){if(bw.overflow!=null&&!b.support.shrinkWrapBlocks){b.each(["","X","Y"],function(bC,bD){bz.style["overflow"+bD]=bw.overflow[bC]})}if(bw.hide){b(bz).hide()}if(bw.hide||bw.show){for(bA in bw.animatedProperties){b.style(bz,bA,bw.orig[bA]);b.removeData(bz,"fxshow"+bA,true);b.removeData(bz,"toggle"+bA,true)}}bv=bw.complete;if(bv){bw.complete=false;bv.call(bz)}}return false}else{if(bw.duration==Infinity){this.now=bx}else{bB=bx-this.startTime;this.state=bB/bw.duration;this.pos=b.easing[bw.animatedProperties[this.prop]](this.state,bB,0,1,bw.duration);this.now=this.start+((this.end-this.start)*this.pos)}this.update()}return true}};b.extend(b.fx,{tick:function(){var bw,bv=b.timers,e=0;for(;e").appendTo(e),bw=bv.css("display");bv.remove();if(bw==="none"||bw===""){if(!a8){a8=av.createElement("iframe");a8.frameBorder=a8.width=a8.height=0}e.appendChild(a8);if(!m||!a8.createElement){m=(a8.contentWindow||a8.contentDocument).document;m.write((av.compatMode==="CSS1Compat"?"":"")+"");m.close()}bv=m.createElement(bx);m.body.appendChild(bv);bw=b.css(bv,"display");e.removeChild(a8)}Q[bx]=bw}return Q[bx]}var V=/^t(?:able|d|h)$/i,ad=/^(?:body|html)$/i;if("getBoundingClientRect" in av.documentElement){b.fn.offset=function(bI){var by=this[0],bB;if(bI){return this.each(function(e){b.offset.setOffset(this,bI,e)})}if(!by||!by.ownerDocument){return null}if(by===by.ownerDocument.body){return b.offset.bodyOffset(by)}try{bB=by.getBoundingClientRect()}catch(bF){}var bH=by.ownerDocument,bw=bH.documentElement;if(!bB||!b.contains(bw,by)){return bB?{top:bB.top,left:bB.left}:{top:0,left:0}}var bC=bH.body,bD=aK(bH),bA=bw.clientTop||bC.clientTop||0,bE=bw.clientLeft||bC.clientLeft||0,bv=bD.pageYOffset||b.support.boxModel&&bw.scrollTop||bC.scrollTop,bz=bD.pageXOffset||b.support.boxModel&&bw.scrollLeft||bC.scrollLeft,bG=bB.top+bv-bA,bx=bB.left+bz-bE;return{top:bG,left:bx}}}else{b.fn.offset=function(bF){var bz=this[0];if(bF){return this.each(function(bG){b.offset.setOffset(this,bF,bG)})}if(!bz||!bz.ownerDocument){return null}if(bz===bz.ownerDocument.body){return b.offset.bodyOffset(bz)}var bC,bw=bz.offsetParent,bv=bz,bE=bz.ownerDocument,bx=bE.documentElement,bA=bE.body,bB=bE.defaultView,e=bB?bB.getComputedStyle(bz,null):bz.currentStyle,bD=bz.offsetTop,by=bz.offsetLeft;while((bz=bz.parentNode)&&bz!==bA&&bz!==bx){if(b.support.fixedPosition&&e.position==="fixed"){break}bC=bB?bB.getComputedStyle(bz,null):bz.currentStyle;bD-=bz.scrollTop;by-=bz.scrollLeft;if(bz===bw){bD+=bz.offsetTop;by+=bz.offsetLeft;if(b.support.doesNotAddBorder&&!(b.support.doesAddBorderForTableAndCells&&V.test(bz.nodeName))){bD+=parseFloat(bC.borderTopWidth)||0;by+=parseFloat(bC.borderLeftWidth)||0}bv=bw;bw=bz.offsetParent}if(b.support.subtractsBorderForOverflowNotVisible&&bC.overflow!=="visible"){bD+=parseFloat(bC.borderTopWidth)||0;by+=parseFloat(bC.borderLeftWidth)||0}e=bC}if(e.position==="relative"||e.position==="static"){bD+=bA.offsetTop;by+=bA.offsetLeft}if(b.support.fixedPosition&&e.position==="fixed"){bD+=Math.max(bx.scrollTop,bA.scrollTop);by+=Math.max(bx.scrollLeft,bA.scrollLeft)}return{top:bD,left:by}}}b.offset={bodyOffset:function(e){var bw=e.offsetTop,bv=e.offsetLeft;if(b.support.doesNotIncludeMarginInBodyOffset){bw+=parseFloat(b.css(e,"marginTop"))||0;bv+=parseFloat(b.css(e,"marginLeft"))||0}return{top:bw,left:bv}},setOffset:function(bx,bG,bA){var bB=b.css(bx,"position");if(bB==="static"){bx.style.position="relative"}var bz=b(bx),bv=bz.offset(),e=b.css(bx,"top"),bE=b.css(bx,"left"),bF=(bB==="absolute"||bB==="fixed")&&b.inArray("auto",[e,bE])>-1,bD={},bC={},bw,by;if(bF){bC=bz.position();bw=bC.top;by=bC.left}else{bw=parseFloat(e)||0;by=parseFloat(bE)||0}if(b.isFunction(bG)){bG=bG.call(bx,bA,bv)}if(bG.top!=null){bD.top=(bG.top-bv.top)+bw}if(bG.left!=null){bD.left=(bG.left-bv.left)+by}if("using" in bG){bG.using.call(bx,bD)}else{bz.css(bD)}}};b.fn.extend({position:function(){if(!this[0]){return null}var bw=this[0],bv=this.offsetParent(),bx=this.offset(),e=ad.test(bv[0].nodeName)?{top:0,left:0}:bv.offset();bx.top-=parseFloat(b.css(bw,"marginTop"))||0;bx.left-=parseFloat(b.css(bw,"marginLeft"))||0;e.top+=parseFloat(b.css(bv[0],"borderTopWidth"))||0;e.left+=parseFloat(b.css(bv[0],"borderLeftWidth"))||0;return{top:bx.top-e.top,left:bx.left-e.left}},offsetParent:function(){return this.map(function(){var e=this.offsetParent||av.body;while(e&&(!ad.test(e.nodeName)&&b.css(e,"position")==="static")){e=e.offsetParent}return e})}});b.each(["Left","Top"],function(bv,e){var bw="scroll"+e;b.fn[bw]=function(bz){var bx,by;if(bz===L){bx=this[0];if(!bx){return null}by=aK(bx);return by?("pageXOffset" in by)?by[bv?"pageYOffset":"pageXOffset"]:b.support.boxModel&&by.document.documentElement[bw]||by.document.body[bw]:bx[bw]}return this.each(function(){by=aK(this);if(by){by.scrollTo(!bv?bz:b(by).scrollLeft(),bv?bz:b(by).scrollTop())}else{this[bw]=bz}})}});function aK(e){return b.isWindow(e)?e:e.nodeType===9?e.defaultView||e.parentWindow:false}b.each(["Height","Width"],function(bv,e){var bw=e.toLowerCase();b.fn["inner"+e]=function(){var bx=this[0];return bx?bx.style?parseFloat(b.css(bx,bw,"padding")):this[bw]():null};b.fn["outer"+e]=function(by){var bx=this[0];return bx?bx.style?parseFloat(b.css(bx,bw,by?"margin":"border")):this[bw]():null};b.fn[bw]=function(bz){var bA=this[0];if(!bA){return bz==null?null:this}if(b.isFunction(bz)){return this.each(function(bE){var bD=b(this);bD[bw](bz.call(this,bE,bD[bw]()))})}if(b.isWindow(bA)){var bB=bA.document.documentElement["client"+e],bx=bA.document.body;return bA.document.compatMode==="CSS1Compat"&&bB||bx&&bx["client"+e]||bB}else{if(bA.nodeType===9){return Math.max(bA.documentElement["client"+e],bA.body["scroll"+e],bA.documentElement["scroll"+e],bA.body["offset"+e],bA.documentElement["offset"+e])}else{if(bz===L){var bC=b.css(bA,bw),by=parseFloat(bC);return b.isNumeric(by)?by:bC}else{return this.css(bw,typeof bz==="string"?bz:bz+"px")}}}}});bb.jQuery=bb.$=b;if(typeof define==="function"&&define.amd&&define.amd.jQuery){define("jquery",[],function(){return b +})}})(window); +/*! + PowerTip - v1.2.0 - 2013-04-03 + http://stevenbenner.github.com/jquery-powertip/ + Copyright (c) 2013 Steven Benner (http://stevenbenner.com/). + Released under MIT license. + https://raw.github.com/stevenbenner/jquery-powertip/master/LICENSE.txt +*/ +(function(a){if(typeof define==="function"&&define.amd){define(["jquery"],a)}else{a(jQuery)}}(function(k){var A=k(document),s=k(window),w=k("body");var n="displayController",e="hasActiveHover",d="forcedOpen",u="hasMouseMove",f="mouseOnToPopup",g="originalTitle",y="powertip",o="powertipjq",l="powertiptarget",E=180/Math.PI;var c={isTipOpen:false,isFixedTipOpen:false,isClosing:false,tipOpenImminent:false,activeHover:null,currentX:0,currentY:0,previousX:0,previousY:0,desyncTimeout:null,mouseTrackingActive:false,delayInProgress:false,windowWidth:0,windowHeight:0,scrollTop:0,scrollLeft:0};var p={none:0,top:1,bottom:2,left:4,right:8};k.fn.powerTip=function(F,N){if(!this.length){return this}if(k.type(F)==="string"&&k.powerTip[F]){return k.powerTip[F].call(this,this,N)}var O=k.extend({},k.fn.powerTip.defaults,F),G=new x(O);h();this.each(function M(){var R=k(this),Q=R.data(y),P=R.data(o),T=R.data(l),S;if(R.data(n)){k.powerTip.destroy(R)}S=R.attr("title");if(!Q&&!T&&!P&&S){R.data(y,S);R.data(g,S);R.removeAttr("title")}R.data(n,new t(R,O,G))});if(!O.manual){this.on({"mouseenter.powertip":function J(P){k.powerTip.show(this,P)},"mouseleave.powertip":function L(){k.powerTip.hide(this)},"focus.powertip":function K(){k.powerTip.show(this)},"blur.powertip":function H(){k.powerTip.hide(this,true)},"keydown.powertip":function I(P){if(P.keyCode===27){k.powerTip.hide(this,true)}}})}return this};k.fn.powerTip.defaults={fadeInTime:200,fadeOutTime:100,followMouse:false,popupId:"powerTip",intentSensitivity:7,intentPollInterval:100,closeDelay:100,placement:"n",smartPlacement:false,offset:10,mouseOnToPopup:false,manual:false};k.fn.powerTip.smartPlacementLists={n:["n","ne","nw","s"],e:["e","ne","se","w","nw","sw","n","s","e"],s:["s","se","sw","n"],w:["w","nw","sw","e","ne","se","n","s","w"],nw:["nw","w","sw","n","s","se","nw"],ne:["ne","e","se","n","s","sw","ne"],sw:["sw","w","nw","s","n","ne","sw"],se:["se","e","ne","s","n","nw","se"],"nw-alt":["nw-alt","n","ne-alt","sw-alt","s","se-alt","w","e"],"ne-alt":["ne-alt","n","nw-alt","se-alt","s","sw-alt","e","w"],"sw-alt":["sw-alt","s","se-alt","nw-alt","n","ne-alt","w","e"],"se-alt":["se-alt","s","sw-alt","ne-alt","n","nw-alt","e","w"]};k.powerTip={show:function z(F,G){if(G){i(G);c.previousX=G.pageX;c.previousY=G.pageY;k(F).data(n).show()}else{k(F).first().data(n).show(true,true)}return F},reposition:function r(F){k(F).first().data(n).resetPosition();return F},hide:function D(G,F){if(G){k(G).first().data(n).hide(F)}else{if(c.activeHover){c.activeHover.data(n).hide(true)}}return G},destroy:function C(G){k(G).off(".powertip").each(function F(){var I=k(this),H=[g,n,e,d];if(I.data(g)){I.attr("title",I.data(g));H.push(y)}I.removeData(H)});return G}};k.powerTip.showTip=k.powerTip.show;k.powerTip.closeTip=k.powerTip.hide;function b(){var F=this;F.top="auto";F.left="auto";F.right="auto";F.bottom="auto";F.set=function(H,G){if(k.isNumeric(G)){F[H]=Math.round(G)}}}function t(K,N,F){var J=null;function L(P,Q){M();if(!K.data(e)){if(!P){c.tipOpenImminent=true;J=setTimeout(function O(){J=null;I()},N.intentPollInterval)}else{if(Q){K.data(d,true)}F.showTip(K)}}}function G(P){M();c.tipOpenImminent=false;if(K.data(e)){K.data(d,false);if(!P){c.delayInProgress=true;J=setTimeout(function O(){J=null;F.hideTip(K);c.delayInProgress=false},N.closeDelay)}else{F.hideTip(K)}}}function I(){var Q=Math.abs(c.previousX-c.currentX),O=Math.abs(c.previousY-c.currentY),P=Q+O;if(P",{id:Q.popupId});if(w.length===0){w=k("body")}w.append(O)}if(Q.followMouse){if(!O.data(u)){A.on("mousemove",M);s.on("scroll",M);O.data(u,true)}}if(Q.mouseOnToPopup){O.on({mouseenter:function L(){if(O.data(f)){if(c.activeHover){c.activeHover.data(n).cancel()}}},mouseleave:function N(){if(c.activeHover){c.activeHover.data(n).hide()}}})}function I(S){S.data(e,true);O.queue(function R(T){H(S);T()})}function H(S){var U;if(!S.data(e)){return}if(c.isTipOpen){if(!c.isClosing){K(c.activeHover)}O.delay(100).queue(function R(V){H(S);V()});return}S.trigger("powerTipPreRender");U=B(S);if(U){O.empty().append(U)}else{return}S.trigger("powerTipRender");c.activeHover=S;c.isTipOpen=true;O.data(f,Q.mouseOnToPopup);if(!Q.followMouse){G(S);c.isFixedTipOpen=true}else{M()}O.fadeIn(Q.fadeInTime,function T(){if(!c.desyncTimeout){c.desyncTimeout=setInterval(J,500)}S.trigger("powerTipOpen")})}function K(R){c.isClosing=true;c.activeHover=null;c.isTipOpen=false;c.desyncTimeout=clearInterval(c.desyncTimeout);R.data(e,false);R.data(d,false);O.fadeOut(Q.fadeOutTime,function S(){var T=new b();c.isClosing=false;c.isFixedTipOpen=false;O.removeClass();T.set("top",c.currentY+Q.offset);T.set("left",c.currentX+Q.offset);O.css(T);R.trigger("powerTipClose")})}function M(){if(!c.isFixedTipOpen&&(c.isTipOpen||(c.tipOpenImminent&&O.data(u)))){var R=O.outerWidth(),V=O.outerHeight(),U=new b(),S,T;U.set("top",c.currentY+Q.offset);U.set("left",c.currentX+Q.offset);S=m(U,R,V);if(S!==p.none){T=a(S);if(T===1){if(S===p.right){U.set("left",c.windowWidth-R)}else{if(S===p.bottom){U.set("top",c.scrollTop+c.windowHeight-V)}}}else{U.set("left",c.currentX-R-Q.offset);U.set("top",c.currentY-V-Q.offset)}}O.css(U)}}function G(S){var R,T;if(Q.smartPlacement){R=k.fn.powerTip.smartPlacementLists[Q.placement];k.each(R,function(U,W){var V=m(F(S,W),O.outerWidth(),O.outerHeight());T=W;if(V===p.none){return false}})}else{F(S,Q.placement);T=Q.placement}O.addClass(T)}function F(U,T){var R=0,S,W,V=new b();V.set("top",0);V.set("left",0);O.css(V);do{S=O.outerWidth();W=O.outerHeight();V=P.compute(U,T,S,W,Q.offset);O.css(V)}while(++R<=5&&(S!==O.outerWidth()||W!==O.outerHeight()));return V}function J(){var R=false;if(c.isTipOpen&&!c.isClosing&&!c.delayInProgress){if(c.activeHover.data(e)===false||c.activeHover.is(":disabled")){R=true}else{if(!v(c.activeHover)&&!c.activeHover.is(":focus")&&!c.activeHover.data(d)){if(O.data(f)){if(!v(O)){R=true}}else{R=true}}}if(R){K(c.activeHover)}}}this.showTip=I;this.hideTip=K;this.resetPosition=G}function q(F){return window.SVGElement&&F[0] instanceof SVGElement}function h(){if(!c.mouseTrackingActive){c.mouseTrackingActive=true;k(function H(){c.scrollLeft=s.scrollLeft();c.scrollTop=s.scrollTop();c.windowWidth=s.width();c.windowHeight=s.height()});A.on("mousemove",i);s.on({resize:function G(){c.windowWidth=s.width();c.windowHeight=s.height()},scroll:function F(){var I=s.scrollLeft(),J=s.scrollTop();if(I!==c.scrollLeft){c.currentX+=I-c.scrollLeft;c.scrollLeft=I}if(J!==c.scrollTop){c.currentY+=J-c.scrollTop;c.scrollTop=J}}})}}function i(F){c.currentX=F.pageX;c.currentY=F.pageY}function v(F){var H=F.offset(),J=F[0].getBoundingClientRect(),I=J.right-J.left,G=J.bottom-J.top;return c.currentX>=H.left&&c.currentX<=H.left+I&&c.currentY>=H.top&&c.currentY<=H.top+G}function B(I){var G=I.data(y),F=I.data(o),K=I.data(l),H,J;if(G){if(k.isFunction(G)){G=G.call(I[0])}J=G}else{if(F){if(k.isFunction(F)){F=F.call(I[0])}if(F.length>0){J=F.clone(true,true)}}else{if(K){H=k("#"+K);if(H.length>0){J=H.html()}}}}return J}function m(M,L,K){var G=c.scrollTop,J=c.scrollLeft,I=G+c.windowHeight,F=J+c.windowWidth,H=p.none;if(M.topI||Math.abs(M.bottom-c.windowHeight)>I){H|=p.bottom}if(M.leftF){H|=p.left}if(M.left+L>F||M.right + + + + + +API: Nextion Library for Arduino + + + + + + +
+
+
+ + + + + + +
+
API +
+
For Arduino developers
+
+ + + + + +
+
+
Nextion Library for Arduino
+
+
+

Nextion Arduino library provides an easy-to-use way to manipulate Nextion serial displays. Users can use the libarry freely, either in commerical projects or open-source prjects, without any additional condiitons.

+

For more information about the Nextion display project, please visit the wiki。 The wiki provdies all the necessary technical documnets, quick start guide, tutorials, demos, as well as some useful resources.

+

To get your Nextion display, please visit iMall.

+

To discuss the project? Request new features? Report a BUG? please visit the Forums

+

​

Source

+

Latest source code can be download at https://github.com/itead/ITEADLIB_Arduino_Nextion.

+

You can clone it by:

git clone https://github.com/itead/ITEADLIB_Arduino_Nextion
+

Hareware requirement

+
    +
  • RAM: not less than 2KBytes
  • +
  • Serial: two serial (communication and debug)
  • +
+

Suppported Mainboards:

+
    +
  • Iteaduino MEGA2560
  • +
  • Arduino MEGA2560
  • +
+
+

DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE Version 2, December 2004

+

Copyright (C) 2014 ITEAD Studio

+

Everyone is permitted to copy and distribute verbatim or modified copies of this license document, and changing it is allowed as long as the name is changed.

   DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE 
+

TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

+

0. You just DO WHAT THE FUCK YOU WANT TO.

+
+
+ + + + diff --git a/doc/API-html/nav_f.png b/doc/API-html/nav_f.png new file mode 100644 index 00000000..86c145d Binary files /dev/null and b/doc/API-html/nav_f.png differ diff --git a/doc/API-html/nav_g.png b/doc/API-html/nav_g.png new file mode 100644 index 00000000..2093a23 Binary files /dev/null and b/doc/API-html/nav_g.png differ diff --git a/doc/API-html/nav_h.png b/doc/API-html/nav_h.png new file mode 100644 index 00000000..be2b899 Binary files /dev/null and b/doc/API-html/nav_h.png differ diff --git a/doc/API-html/open.png b/doc/API-html/open.png new file mode 100644 index 00000000..6297c0c Binary files /dev/null and b/doc/API-html/open.png differ diff --git a/doc/API-html/pages.html b/doc/API-html/pages.html new file mode 100644 index 00000000..fdd800d --- /dev/null +++ b/doc/API-html/pages.html @@ -0,0 +1,59 @@ + + + + + + +API: Related Pages + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + +
+
+
+
Related Pages
+
+
+
Here is a list of all related documentation pages:
+
+ + + + diff --git a/doc/API-html/readme_8md_source.html b/doc/API-html/readme_8md_source.html new file mode 100644 index 00000000..ff634bf --- /dev/null +++ b/doc/API-html/readme_8md_source.html @@ -0,0 +1,112 @@ + + + + + + +API: readme.md Source File + + + + + + +
+
+ + + + + + + +
+
API +
+
For Arduino developers
+
+
+ + + + +
+
+
+
readme.md
+
+
+
1 # Nextion Library for Arduino
+
2 
+
3 Nextion Arduino library provides an easy-to-use way to manipulate Nextion serial displays.
+
4 Users can use the libarry freely, either in commerical projects or open-source prjects, without any additional condiitons.
+
5 
+
6 For more information about the Nextion display project, please visit [the wiki。](http://wiki.iteadstudio.com/Nextion_HMI_Solution)
+
7 The wiki provdies all the necessary technical documnets, quick start guide, tutorials, demos, as well as some useful resources.
+
8 
+
9 To get your Nextion display, please visit [iMall.](http://imall.itead.cc/display/nextion.html)
+
10 
+
11 To discuss the project? Request new features? Report a BUG? please visit the [Forums](http://support.iteadstudio.com/discussions/1000058038)
+
12 
+
13 â€‹
+
14 # Source
+
15 
+
16 Latest source code can be download at https://github.com/itead/ITEADLIB_Arduino_Nextion.
+
17 
+
18 You can clone it by:
+
19 
+
20  git clone https://github.com/itead/ITEADLIB_Arduino_Nextion
+
21 
+
22 # Hareware requirement
+
23 
+
24  - RAM: not less than 2KBytes
+
25  - Serial: two serial (communication and debug)
+
26 
+
27 # Suppported Mainboards:
+
28 
+
29  - Iteaduino MEGA2560
+
30  - Arduino MEGA2560
+
31 
+
32 
+
33 -------------------------------------------------------------------------------
+
34 
+
35 
+
36  DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+
37  Version 2, December 2004
+
38 
+
39  Copyright (C) 2014 ITEAD Studio
+
40 
+
41  Everyone is permitted to copy and distribute verbatim or modified
+
42  copies of this license document, and changing it is allowed as long
+
43  as the name is changed.
+
44 
+
45  DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+
46 
+
47  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
48 
+
49  0. You just DO WHAT THE FUCK YOU WANT TO.
+
50 
+
51 
+
52 -------------------------------------------------------------------------------
+
+ + + + diff --git a/doc/API-html/sync_off.png b/doc/API-html/sync_off.png new file mode 100644 index 00000000..f168259 Binary files /dev/null and b/doc/API-html/sync_off.png differ diff --git a/doc/API-html/sync_on.png b/doc/API-html/sync_on.png new file mode 100644 index 00000000..76e6eed Binary files /dev/null and b/doc/API-html/sync_on.png differ diff --git a/doc/API-html/tab_a.png b/doc/API-html/tab_a.png new file mode 100644 index 00000000..f1dac83 Binary files /dev/null and b/doc/API-html/tab_a.png differ diff --git a/doc/API-html/tab_b.png b/doc/API-html/tab_b.png new file mode 100644 index 00000000..23b6b7e Binary files /dev/null and b/doc/API-html/tab_b.png differ diff --git a/doc/API-html/tab_h.png b/doc/API-html/tab_h.png new file mode 100644 index 00000000..d38741b Binary files /dev/null and b/doc/API-html/tab_h.png differ diff --git a/doc/API-html/tab_s.png b/doc/API-html/tab_s.png new file mode 100644 index 00000000..6d9d4fa Binary files /dev/null and b/doc/API-html/tab_s.png differ diff --git a/doc/API-html/tabs.css b/doc/API-html/tabs.css new file mode 100644 index 00000000..13e4654 --- /dev/null +++ b/doc/API-html/tabs.css @@ -0,0 +1,60 @@ +.tabs, .tabs2, .tabs3 { + background-image: url('tab_b.png'); + width: 100%; + z-index: 101; + font-size: 13px; + font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; +} + +.tabs2 { + font-size: 10px; +} +.tabs3 { + font-size: 9px; +} + +.tablist { + margin: 0; + padding: 0; + display: table; +} + +.tablist li { + float: left; + display: table-cell; + background-image: url('tab_b.png'); + line-height: 36px; + list-style: none; +} + +.tablist a { + display: block; + padding: 0 20px; + font-weight: bold; + background-image:url('tab_s.png'); + background-repeat:no-repeat; + background-position:right; + color: #184C80; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + text-decoration: none; + outline: none; +} + +.tabs3 .tablist a { + padding: 0 10px; +} + +.tablist a:hover { + background-image: url('tab_h.png'); + background-repeat:repeat-x; + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); + text-decoration: none; +} + +.tablist li.current a { + background-image: url('tab_a.png'); + background-repeat:repeat-x; + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +} diff --git a/doc/API.chm b/doc/API.chm new file mode 100644 index 00000000..349e4fe Binary files /dev/null and b/doc/API.chm differ diff --git a/doc/ITEAD-logo.JPG b/doc/ITEAD-logo.JPG new file mode 100644 index 00000000..b13d5c0 Binary files /dev/null and b/doc/ITEAD-logo.JPG differ diff --git a/doxygen.doxy b/doxygen.doxy new file mode 100644 index 00000000..d316c42 --- /dev/null +++ b/doxygen.doxy @@ -0,0 +1,2382 @@ +# Doxyfile 1.8.7 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = API + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "For Arduino developers" + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = Z:/zlctemp/project/ITEADLIB_Arduino_Nextion/doc/ITEAD-logo.JPG + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = doc + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = NO + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = YES + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = YES + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = YES + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = . + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.f90 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.as \ + *.js \ + *.ino \ + *.ino + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = examples + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# compiled with the --with-libclang option. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = API-html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 210 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 173 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 72 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = YES + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = ../API.chm + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = "C:/Program Files/HTML Help Workshop/hhc.exe" + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /