Deployed 506b5bb to 5.4 with MkDocs 1.1.2 and mike 0.5.5
[GitHub/WoltLab/woltlab.github.io.git] / latest / package / pip / clipboard-action / index.html
1
2 <!doctype html>
3 <html lang="en" class="no-js">
4 <head>
5
6 <meta charset="utf-8">
7 <meta name="viewport" content="width=device-width,initial-scale=1">
8
9
10
11
12 <link rel="shortcut icon" href="../../../assets/default.favicon.ico">
13 <meta name="generator" content="mkdocs-1.1.2, mkdocs-material-7.0.5">
14
15
16
17 <title>clipboardAction - WoltLab Suite Documentation</title>
18
19
20
21 <link rel="stylesheet" href="../../../assets/stylesheets/main.77f3fd56.min.css">
22
23
24 <link rel="stylesheet" href="../../../assets/stylesheets/palette.7fa14f5b.min.css">
25
26
27
28 <meta name="theme-color" content="#009485">
29
30
31
32
33
34
35
36
37 <link rel="stylesheet" href="../../../stylesheets/extra.css">
38
39
40
41
42
43 </head>
44
45
46
47
48
49
50
51 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="teal" data-md-color-accent="">
52
53
54
55 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
56 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
57 <label class="md-overlay" for="__drawer"></label>
58 <div data-md-component="skip">
59
60
61 <a href="#clipboard-action-package-installation-plugin" class="md-skip">
62 Skip to content
63 </a>
64
65 </div>
66 <div data-md-component="announce">
67
68 <aside class="md-announce">
69 <div class="md-announce__inner md-grid md-typeset">
70
71 <a href="https://www.woltlab.com">Back to <strong>woltlab.com</strong></a>
72
73 </div>
74 </aside>
75
76 </div>
77
78
79
80 <header class="md-header" data-md-component="header">
81 <nav class="md-header__inner md-grid" aria-label="Header">
82 <a href="../../.." title="WoltLab Suite Documentation" class="md-header__button md-logo" aria-label="WoltLab Suite Documentation">
83
84 <img src="../../../assets/logo.png" alt="logo">
85
86 </a>
87 <label class="md-header__button md-icon" for="__drawer">
88 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
89 </label>
90 <div class="md-header__title" data-md-component="header-title">
91 <div class="md-header__ellipsis">
92 <div class="md-header__topic">
93 <span class="md-ellipsis">
94 WoltLab Suite Documentation
95 </span>
96 </div>
97 <div class="md-header__topic" data-md-component="header-topic">
98 <span class="md-ellipsis">
99
100 clipboardAction
101
102 </span>
103 </div>
104 </div>
105 </div>
106 <div class="md-header__options">
107
108 </div>
109
110 <label class="md-header__button md-icon" for="__search">
111 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
112 </label>
113
114 <div class="md-search" data-md-component="search" role="dialog">
115 <label class="md-search__overlay" for="__search"></label>
116 <div class="md-search__inner" role="search">
117 <form class="md-search__form" name="search">
118 <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active" required>
119 <label class="md-search__icon md-icon" for="__search">
120 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
121 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
122 </label>
123 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
124 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
125 </button>
126 </form>
127 <div class="md-search__output">
128 <div class="md-search__scrollwrap" data-md-scrollfix>
129 <div class="md-search-result" data-md-component="search-result">
130 <div class="md-search-result__meta">
131 Initializing search
132 </div>
133 <ol class="md-search-result__list"></ol>
134 </div>
135 </div>
136 </div>
137 </div>
138 </div>
139
140
141 </nav>
142 </header>
143
144 <div class="md-container" data-md-component="container">
145
146
147
148
149 <main class="md-main" data-md-component="main">
150 <div class="md-main__inner md-grid">
151
152
153
154 <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
155 <div class="md-sidebar__scrollwrap">
156 <div class="md-sidebar__inner">
157
158
159
160
161
162 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
163 <label class="md-nav__title" for="__drawer">
164 <a href="../../.." title="WoltLab Suite Documentation" class="md-nav__button md-logo" aria-label="WoltLab Suite Documentation">
165
166 <img src="../../../assets/logo.png" alt="logo">
167
168 </a>
169 WoltLab Suite Documentation
170 </label>
171
172 <ul class="md-nav__list" data-md-scrollfix>
173
174
175
176
177
178
179
180
181 <li class="md-nav__item">
182 <a href="../../../getting-started/" class="md-nav__link">
183 Getting Started
184 </a>
185 </li>
186
187
188
189
190
191
192
193
194
195
196
197 <li class="md-nav__item md-nav__item--nested">
198
199
200 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
201
202 <label class="md-nav__link" for="__nav_2">
203 PHP API
204 <span class="md-nav__icon md-icon"></span>
205 </label>
206 <nav class="md-nav" aria-label="PHP API" data-md-level="1">
207 <label class="md-nav__title" for="__nav_2">
208 <span class="md-nav__icon md-icon"></span>
209 PHP API
210 </label>
211 <ul class="md-nav__list" data-md-scrollfix>
212
213
214
215
216
217 <li class="md-nav__item">
218 <a href="../../../php/pages/" class="md-nav__link">
219 Pages
220 </a>
221 </li>
222
223
224
225
226
227
228
229 <li class="md-nav__item">
230 <a href="../../../php/database-objects/" class="md-nav__link">
231 Database Objects
232 </a>
233 </li>
234
235
236
237
238
239
240
241 <li class="md-nav__item">
242 <a href="../../../php/database-access/" class="md-nav__link">
243 Database Access
244 </a>
245 </li>
246
247
248
249
250
251
252
253 <li class="md-nav__item">
254 <a href="../../../php/exceptions/" class="md-nav__link">
255 Exceptions
256 </a>
257 </li>
258
259
260
261
262
263
264
265
266 <li class="md-nav__item md-nav__item--nested">
267
268
269 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5" type="checkbox" id="__nav_2_5" >
270
271 <label class="md-nav__link" for="__nav_2_5">
272 API
273 <span class="md-nav__icon md-icon"></span>
274 </label>
275 <nav class="md-nav" aria-label="API" data-md-level="2">
276 <label class="md-nav__title" for="__nav_2_5">
277 <span class="md-nav__icon md-icon"></span>
278 API
279 </label>
280 <ul class="md-nav__list" data-md-scrollfix>
281
282
283
284
285
286 <li class="md-nav__item">
287 <a href="../../../php/api/caches/" class="md-nav__link">
288 Caches
289 </a>
290 </li>
291
292
293
294
295
296
297
298 <li class="md-nav__item">
299 <a href="../../../php/api/comments/" class="md-nav__link">
300 Comments
301 </a>
302 </li>
303
304
305
306
307
308
309
310 <li class="md-nav__item">
311 <a href="../../../php/api/cronjobs/" class="md-nav__link">
312 Cronjobs
313 </a>
314 </li>
315
316
317
318
319
320
321
322 <li class="md-nav__item">
323 <a href="../../../php/api/events/" class="md-nav__link">
324 Events
325 </a>
326 </li>
327
328
329
330
331
332
333
334
335 <li class="md-nav__item md-nav__item--nested">
336
337
338 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_5_5" type="checkbox" id="__nav_2_5_5" >
339
340 <label class="md-nav__link" for="__nav_2_5_5">
341 Form Builder
342 <span class="md-nav__icon md-icon"></span>
343 </label>
344 <nav class="md-nav" aria-label="Form Builder" data-md-level="3">
345 <label class="md-nav__title" for="__nav_2_5_5">
346 <span class="md-nav__icon md-icon"></span>
347 Form Builder
348 </label>
349 <ul class="md-nav__list" data-md-scrollfix>
350
351
352
353
354
355 <li class="md-nav__item">
356 <a href="../../../php/api/form_builder/overview/" class="md-nav__link">
357 Overview
358 </a>
359 </li>
360
361
362
363
364
365
366
367 <li class="md-nav__item">
368 <a href="../../../php/api/form_builder/structure/" class="md-nav__link">
369 Structure
370 </a>
371 </li>
372
373
374
375
376
377
378
379 <li class="md-nav__item">
380 <a href="../../../php/api/form_builder/form_fields/" class="md-nav__link">
381 Fields
382 </a>
383 </li>
384
385
386
387
388
389
390
391 <li class="md-nav__item">
392 <a href="../../../php/api/form_builder/validation_data/" class="md-nav__link">
393 Validation and Data
394 </a>
395 </li>
396
397
398
399
400
401
402
403 <li class="md-nav__item">
404 <a href="../../../php/api/form_builder/dependencies/" class="md-nav__link">
405 Dependencies
406 </a>
407 </li>
408
409
410
411 </ul>
412 </nav>
413 </li>
414
415
416
417
418
419
420
421 <li class="md-nav__item">
422 <a href="../../../php/api/package_installation_plugins/" class="md-nav__link">
423 Package Installation Plugins
424 </a>
425 </li>
426
427
428
429
430
431
432
433 <li class="md-nav__item">
434 <a href="../../../php/api/user_activity_points/" class="md-nav__link">
435 User Activity Points
436 </a>
437 </li>
438
439
440
441
442
443
444
445 <li class="md-nav__item">
446 <a href="../../../php/api/user_notifications/" class="md-nav__link">
447 User Notifications
448 </a>
449 </li>
450
451
452
453
454
455
456
457 <li class="md-nav__item">
458 <a href="../../../php/api/sitemaps/" class="md-nav__link">
459 Sitemaps
460 </a>
461 </li>
462
463
464
465 </ul>
466 </nav>
467 </li>
468
469
470
471
472
473
474
475 <li class="md-nav__item">
476 <a href="../../../php/code-style/" class="md-nav__link">
477 Code Style
478 </a>
479 </li>
480
481
482
483
484
485
486
487 <li class="md-nav__item">
488 <a href="../../../php/apps/" class="md-nav__link">
489 Apps
490 </a>
491 </li>
492
493
494
495
496
497
498
499 <li class="md-nav__item">
500 <a href="../../../php/gdpr/" class="md-nav__link">
501 GDPR
502 </a>
503 </li>
504
505
506
507 </ul>
508 </nav>
509 </li>
510
511
512
513
514
515
516
517
518
519
520
521 <li class="md-nav__item md-nav__item--nested">
522
523
524 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
525
526 <label class="md-nav__link" for="__nav_3">
527 Languages, Templates & CSS
528 <span class="md-nav__icon md-icon"></span>
529 </label>
530 <nav class="md-nav" aria-label="Languages, Templates & CSS" data-md-level="1">
531 <label class="md-nav__title" for="__nav_3">
532 <span class="md-nav__icon md-icon"></span>
533 Languages, Templates & CSS
534 </label>
535 <ul class="md-nav__list" data-md-scrollfix>
536
537
538
539
540
541 <li class="md-nav__item">
542 <a href="../../../view/languages/" class="md-nav__link">
543 Languages
544 </a>
545 </li>
546
547
548
549
550
551
552
553 <li class="md-nav__item">
554 <a href="../../../view/templates/" class="md-nav__link">
555 Templates
556 </a>
557 </li>
558
559
560
561
562
563
564
565 <li class="md-nav__item">
566 <a href="../../../view/css/" class="md-nav__link">
567 CSS
568 </a>
569 </li>
570
571
572
573 </ul>
574 </nav>
575 </li>
576
577
578
579
580
581
582
583
584
585
586
587 <li class="md-nav__item md-nav__item--nested">
588
589
590 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" >
591
592 <label class="md-nav__link" for="__nav_4">
593 JavaScript API
594 <span class="md-nav__icon md-icon"></span>
595 </label>
596 <nav class="md-nav" aria-label="JavaScript API" data-md-level="1">
597 <label class="md-nav__title" for="__nav_4">
598 <span class="md-nav__icon md-icon"></span>
599 JavaScript API
600 </label>
601 <ul class="md-nav__list" data-md-scrollfix>
602
603
604
605
606
607 <li class="md-nav__item">
608 <a href="../../../javascript/general-usage/" class="md-nav__link">
609 General Usage
610 </a>
611 </li>
612
613
614
615
616
617
618
619
620 <li class="md-nav__item md-nav__item--nested">
621
622
623 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4_2" type="checkbox" id="__nav_4_2" >
624
625 <label class="md-nav__link" for="__nav_4_2">
626 New API
627 <span class="md-nav__icon md-icon"></span>
628 </label>
629 <nav class="md-nav" aria-label="New API" data-md-level="2">
630 <label class="md-nav__title" for="__nav_4_2">
631 <span class="md-nav__icon md-icon"></span>
632 New API
633 </label>
634 <ul class="md-nav__list" data-md-scrollfix>
635
636
637
638
639
640 <li class="md-nav__item">
641 <a href="../../../javascript/new-api_writing-a-module/" class="md-nav__link">
642 Writing a module
643 </a>
644 </li>
645
646
647
648
649
650
651
652 <li class="md-nav__item">
653 <a href="../../../javascript/new-api_data-structures/" class="md-nav__link">
654 Data Structures
655 </a>
656 </li>
657
658
659
660
661
662
663
664 <li class="md-nav__item">
665 <a href="../../../javascript/new-api_core/" class="md-nav__link">
666 Core Functions
667 </a>
668 </li>
669
670
671
672
673
674
675
676 <li class="md-nav__item">
677 <a href="../../../javascript/new-api_dom/" class="md-nav__link">
678 DOM
679 </a>
680 </li>
681
682
683
684
685
686
687
688 <li class="md-nav__item">
689 <a href="../../../javascript/new-api_events/" class="md-nav__link">
690 Event Handling
691 </a>
692 </li>
693
694
695
696
697
698
699
700 <li class="md-nav__item">
701 <a href="../../../javascript/new-api_ajax/" class="md-nav__link">
702 Ajax
703 </a>
704 </li>
705
706
707
708
709
710
711
712 <li class="md-nav__item">
713 <a href="../../../javascript/new-api_dialogs/" class="md-nav__link">
714 Dialogs
715 </a>
716 </li>
717
718
719
720
721
722
723
724 <li class="md-nav__item">
725 <a href="../../../javascript/new-api_browser/" class="md-nav__link">
726 Browser and Screen Sizes
727 </a>
728 </li>
729
730
731
732
733
734
735
736 <li class="md-nav__item">
737 <a href="../../../javascript/new-api_ui/" class="md-nav__link">
738 User Interface
739 </a>
740 </li>
741
742
743
744 </ul>
745 </nav>
746 </li>
747
748
749
750
751
752
753
754 <li class="md-nav__item">
755 <a href="../../../javascript/legacy-api/" class="md-nav__link">
756 Legacy API
757 </a>
758 </li>
759
760
761
762
763
764
765
766 <li class="md-nav__item">
767 <a href="../../../javascript/helper-functions/" class="md-nav__link">
768 Helper Functions
769 </a>
770 </li>
771
772
773
774
775
776
777
778 <li class="md-nav__item">
779 <a href="../../../javascript/code-snippets/" class="md-nav__link">
780 Code Snippets
781 </a>
782 </li>
783
784
785
786 </ul>
787 </nav>
788 </li>
789
790
791
792
793
794
795
796
797
798
799
800
801
802 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
803
804
805 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" checked>
806
807 <label class="md-nav__link" for="__nav_5">
808 Package Components
809 <span class="md-nav__icon md-icon"></span>
810 </label>
811 <nav class="md-nav" aria-label="Package Components" data-md-level="1">
812 <label class="md-nav__title" for="__nav_5">
813 <span class="md-nav__icon md-icon"></span>
814 Package Components
815 </label>
816 <ul class="md-nav__list" data-md-scrollfix>
817
818
819
820
821
822 <li class="md-nav__item">
823 <a href="../../package-xml/" class="md-nav__link">
824 package.xml
825 </a>
826 </li>
827
828
829
830
831
832
833
834
835
836
837 <li class="md-nav__item md-nav__item--active md-nav__item--nested">
838
839
840 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" checked>
841
842 <label class="md-nav__link" for="__nav_5_2">
843 PIPs
844 <span class="md-nav__icon md-icon"></span>
845 </label>
846 <nav class="md-nav" aria-label="PIPs" data-md-level="2">
847 <label class="md-nav__title" for="__nav_5_2">
848 <span class="md-nav__icon md-icon"></span>
849 PIPs
850 </label>
851 <ul class="md-nav__list" data-md-scrollfix>
852
853
854
855
856
857 <li class="md-nav__item">
858 <a href="../" class="md-nav__link">
859 Overview
860 </a>
861 </li>
862
863
864
865
866
867
868
869 <li class="md-nav__item">
870 <a href="../acl-option/" class="md-nav__link">
871 aclOption
872 </a>
873 </li>
874
875
876
877
878
879
880
881 <li class="md-nav__item">
882 <a href="../acp-menu/" class="md-nav__link">
883 acpMenu
884 </a>
885 </li>
886
887
888
889
890
891
892
893 <li class="md-nav__item">
894 <a href="../acp-search-provider/" class="md-nav__link">
895 acpSearchProvider
896 </a>
897 </li>
898
899
900
901
902
903
904
905 <li class="md-nav__item">
906 <a href="../acp-template/" class="md-nav__link">
907 acpTemplate
908 </a>
909 </li>
910
911
912
913
914
915
916
917 <li class="md-nav__item">
918 <a href="../bbcode/" class="md-nav__link">
919 bbcode
920 </a>
921 </li>
922
923
924
925
926
927
928
929 <li class="md-nav__item">
930 <a href="../box/" class="md-nav__link">
931 box
932 </a>
933 </li>
934
935
936
937
938
939
940
941
942
943 <li class="md-nav__item md-nav__item--active">
944
945 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
946
947
948
949
950 <label class="md-nav__link md-nav__link--active" for="__toc">
951 clipboardAction
952 <span class="md-nav__icon md-icon"></span>
953 </label>
954
955 <a href="./" class="md-nav__link md-nav__link--active">
956 clipboardAction
957 </a>
958
959
960 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
961
962
963
964
965
966 <label class="md-nav__title" for="__toc">
967 <span class="md-nav__icon md-icon"></span>
968 Table of contents
969 </label>
970 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
971
972 <li class="md-nav__item">
973 <a href="#components" class="md-nav__link">
974 Components
975 </a>
976
977 <nav class="md-nav" aria-label="Components">
978 <ul class="md-nav__list">
979
980 <li class="md-nav__item">
981 <a href="#actionclassname" class="md-nav__link">
982 &lt;actionclassname&gt;
983 </a>
984
985 </li>
986
987 <li class="md-nav__item">
988 <a href="#pages" class="md-nav__link">
989 &lt;pages&gt;
990 </a>
991
992 </li>
993
994 <li class="md-nav__item">
995 <a href="#showorder" class="md-nav__link">
996 &lt;showorder&gt;
997 </a>
998
999 </li>
1000
1001 </ul>
1002 </nav>
1003
1004 </li>
1005
1006 <li class="md-nav__item">
1007 <a href="#example" class="md-nav__link">
1008 Example
1009 </a>
1010
1011 </li>
1012
1013 </ul>
1014
1015 </nav>
1016
1017 </li>
1018
1019
1020
1021
1022
1023
1024
1025 <li class="md-nav__item">
1026 <a href="../core-object/" class="md-nav__link">
1027 coreObject
1028 </a>
1029 </li>
1030
1031
1032
1033
1034
1035
1036
1037 <li class="md-nav__item">
1038 <a href="../cronjob/" class="md-nav__link">
1039 cronjob
1040 </a>
1041 </li>
1042
1043
1044
1045
1046
1047
1048
1049 <li class="md-nav__item">
1050 <a href="../event-listener/" class="md-nav__link">
1051 eventListener
1052 </a>
1053 </li>
1054
1055
1056
1057
1058
1059
1060
1061 <li class="md-nav__item">
1062 <a href="../file/" class="md-nav__link">
1063 file
1064 </a>
1065 </li>
1066
1067
1068
1069
1070
1071
1072
1073 <li class="md-nav__item">
1074 <a href="../language/" class="md-nav__link">
1075 language
1076 </a>
1077 </li>
1078
1079
1080
1081
1082
1083
1084
1085 <li class="md-nav__item">
1086 <a href="../media-provider/" class="md-nav__link">
1087 mediaProvider
1088 </a>
1089 </li>
1090
1091
1092
1093
1094
1095
1096
1097 <li class="md-nav__item">
1098 <a href="../menu/" class="md-nav__link">
1099 menu
1100 </a>
1101 </li>
1102
1103
1104
1105
1106
1107
1108
1109 <li class="md-nav__item">
1110 <a href="../menu-item/" class="md-nav__link">
1111 menuItem
1112 </a>
1113 </li>
1114
1115
1116
1117
1118
1119
1120
1121 <li class="md-nav__item">
1122 <a href="../object-type/" class="md-nav__link">
1123 objectType
1124 </a>
1125 </li>
1126
1127
1128
1129
1130
1131
1132
1133 <li class="md-nav__item">
1134 <a href="../object-type-definition/" class="md-nav__link">
1135 objectTypeDefinition
1136 </a>
1137 </li>
1138
1139
1140
1141
1142
1143
1144
1145 <li class="md-nav__item">
1146 <a href="../option/" class="md-nav__link">
1147 option
1148 </a>
1149 </li>
1150
1151
1152
1153
1154
1155
1156
1157 <li class="md-nav__item">
1158 <a href="../page/" class="md-nav__link">
1159 page
1160 </a>
1161 </li>
1162
1163
1164
1165
1166
1167
1168
1169 <li class="md-nav__item">
1170 <a href="../pip/" class="md-nav__link">
1171 pip
1172 </a>
1173 </li>
1174
1175
1176
1177
1178
1179
1180
1181 <li class="md-nav__item">
1182 <a href="../script/" class="md-nav__link">
1183 script
1184 </a>
1185 </li>
1186
1187
1188
1189
1190
1191
1192
1193 <li class="md-nav__item">
1194 <a href="../smiley/" class="md-nav__link">
1195 smiley
1196 </a>
1197 </li>
1198
1199
1200
1201
1202
1203
1204
1205 <li class="md-nav__item">
1206 <a href="../sql/" class="md-nav__link">
1207 sql
1208 </a>
1209 </li>
1210
1211
1212
1213
1214
1215
1216
1217 <li class="md-nav__item">
1218 <a href="../style/" class="md-nav__link">
1219 style
1220 </a>
1221 </li>
1222
1223
1224
1225
1226
1227
1228
1229 <li class="md-nav__item">
1230 <a href="../template/" class="md-nav__link">
1231 template
1232 </a>
1233 </li>
1234
1235
1236
1237
1238
1239
1240
1241 <li class="md-nav__item">
1242 <a href="../template-listener/" class="md-nav__link">
1243 templateListener
1244 </a>
1245 </li>
1246
1247
1248
1249
1250
1251
1252
1253 <li class="md-nav__item">
1254 <a href="../user-group-option/" class="md-nav__link">
1255 userGroupOption
1256 </a>
1257 </li>
1258
1259
1260
1261
1262
1263
1264
1265 <li class="md-nav__item">
1266 <a href="../user-menu/" class="md-nav__link">
1267 userMenu
1268 </a>
1269 </li>
1270
1271
1272
1273
1274
1275
1276
1277 <li class="md-nav__item">
1278 <a href="../user-notification-event/" class="md-nav__link">
1279 userNotificationEvent
1280 </a>
1281 </li>
1282
1283
1284
1285
1286
1287
1288
1289 <li class="md-nav__item">
1290 <a href="../user-option/" class="md-nav__link">
1291 userOption
1292 </a>
1293 </li>
1294
1295
1296
1297
1298
1299
1300
1301 <li class="md-nav__item">
1302 <a href="../user-profile-menu/" class="md-nav__link">
1303 userProfileMenu
1304 </a>
1305 </li>
1306
1307
1308
1309 </ul>
1310 </nav>
1311 </li>
1312
1313
1314
1315
1316
1317
1318
1319 <li class="md-nav__item">
1320 <a href="../../database-php-api/" class="md-nav__link">
1321 Database PHP API
1322 </a>
1323 </li>
1324
1325
1326
1327 </ul>
1328 </nav>
1329 </li>
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341 <li class="md-nav__item md-nav__item--nested">
1342
1343
1344 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" >
1345
1346 <label class="md-nav__link" for="__nav_6">
1347 Migration
1348 <span class="md-nav__icon md-icon"></span>
1349 </label>
1350 <nav class="md-nav" aria-label="Migration" data-md-level="1">
1351 <label class="md-nav__title" for="__nav_6">
1352 <span class="md-nav__icon md-icon"></span>
1353 Migration
1354 </label>
1355 <ul class="md-nav__list" data-md-scrollfix>
1356
1357
1358
1359
1360
1361
1362 <li class="md-nav__item md-nav__item--nested">
1363
1364
1365 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_1" type="checkbox" id="__nav_6_1" >
1366
1367 <label class="md-nav__link" for="__nav_6_1">
1368 Migrating from WSC 5.3
1369 <span class="md-nav__icon md-icon"></span>
1370 </label>
1371 <nav class="md-nav" aria-label="Migrating from WSC 5.3" data-md-level="2">
1372 <label class="md-nav__title" for="__nav_6_1">
1373 <span class="md-nav__icon md-icon"></span>
1374 Migrating from WSC 5.3
1375 </label>
1376 <ul class="md-nav__list" data-md-scrollfix>
1377
1378
1379
1380
1381
1382 <li class="md-nav__item">
1383 <a href="../../../migration/wsc53/php/" class="md-nav__link">
1384 PHP API
1385 </a>
1386 </li>
1387
1388
1389
1390
1391
1392
1393
1394 <li class="md-nav__item">
1395 <a href="../../../migration/wsc53/session/" class="md-nav__link">
1396 Session Handling and Authentication
1397 </a>
1398 </li>
1399
1400
1401
1402
1403
1404
1405
1406 <li class="md-nav__item">
1407 <a href="../../../migration/wsc53/javascript/" class="md-nav__link">
1408 JavaScript
1409 </a>
1410 </li>
1411
1412
1413
1414
1415
1416
1417
1418 <li class="md-nav__item">
1419 <a href="../../../migration/wsc53/templates/" class="md-nav__link">
1420 Templates
1421 </a>
1422 </li>
1423
1424
1425
1426
1427
1428
1429
1430 <li class="md-nav__item">
1431 <a href="../../../migration/wsc53/libraries/" class="md-nav__link">
1432 Third Party Libraries
1433 </a>
1434 </li>
1435
1436
1437
1438 </ul>
1439 </nav>
1440 </li>
1441
1442
1443
1444
1445
1446
1447
1448
1449 <li class="md-nav__item md-nav__item--nested">
1450
1451
1452 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_2" type="checkbox" id="__nav_6_2" >
1453
1454 <label class="md-nav__link" for="__nav_6_2">
1455 Migrating from WSC 5.2
1456 <span class="md-nav__icon md-icon"></span>
1457 </label>
1458 <nav class="md-nav" aria-label="Migrating from WSC 5.2" data-md-level="2">
1459 <label class="md-nav__title" for="__nav_6_2">
1460 <span class="md-nav__icon md-icon"></span>
1461 Migrating from WSC 5.2
1462 </label>
1463 <ul class="md-nav__list" data-md-scrollfix>
1464
1465
1466
1467
1468
1469 <li class="md-nav__item">
1470 <a href="../../../migration/wsc52/php/" class="md-nav__link">
1471 PHP API
1472 </a>
1473 </li>
1474
1475
1476
1477
1478
1479
1480
1481 <li class="md-nav__item">
1482 <a href="../../../migration/wsc52/templates/" class="md-nav__link">
1483 Templates and Languages
1484 </a>
1485 </li>
1486
1487
1488
1489
1490
1491
1492
1493 <li class="md-nav__item">
1494 <a href="../../../migration/wsc52/libraries/" class="md-nav__link">
1495 Third Party Libraries
1496 </a>
1497 </li>
1498
1499
1500
1501 </ul>
1502 </nav>
1503 </li>
1504
1505
1506
1507
1508
1509
1510
1511
1512 <li class="md-nav__item md-nav__item--nested">
1513
1514
1515 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_3" type="checkbox" id="__nav_6_3" >
1516
1517 <label class="md-nav__link" for="__nav_6_3">
1518 Migrating from WSC 3.1
1519 <span class="md-nav__icon md-icon"></span>
1520 </label>
1521 <nav class="md-nav" aria-label="Migrating from WSC 3.1" data-md-level="2">
1522 <label class="md-nav__title" for="__nav_6_3">
1523 <span class="md-nav__icon md-icon"></span>
1524 Migrating from WSC 3.1
1525 </label>
1526 <ul class="md-nav__list" data-md-scrollfix>
1527
1528
1529
1530
1531
1532 <li class="md-nav__item">
1533 <a href="../../../migration/wsc31/php/" class="md-nav__link">
1534 PHP API
1535 </a>
1536 </li>
1537
1538
1539
1540 </ul>
1541 </nav>
1542 </li>
1543
1544
1545
1546
1547
1548
1549
1550
1551 <li class="md-nav__item md-nav__item--nested">
1552
1553
1554 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_4" type="checkbox" id="__nav_6_4" >
1555
1556 <label class="md-nav__link" for="__nav_6_4">
1557 Migrating from WSC 3.0
1558 <span class="md-nav__icon md-icon"></span>
1559 </label>
1560 <nav class="md-nav" aria-label="Migrating from WSC 3.0" data-md-level="2">
1561 <label class="md-nav__title" for="__nav_6_4">
1562 <span class="md-nav__icon md-icon"></span>
1563 Migrating from WSC 3.0
1564 </label>
1565 <ul class="md-nav__list" data-md-scrollfix>
1566
1567
1568
1569
1570
1571 <li class="md-nav__item">
1572 <a href="../../../migration/wsc30/php/" class="md-nav__link">
1573 PHP API
1574 </a>
1575 </li>
1576
1577
1578
1579
1580
1581
1582
1583 <li class="md-nav__item">
1584 <a href="../../../migration/wsc30/javascript/" class="md-nav__link">
1585 JavaScript API
1586 </a>
1587 </li>
1588
1589
1590
1591
1592
1593
1594
1595 <li class="md-nav__item">
1596 <a href="../../../migration/wsc30/templates/" class="md-nav__link">
1597 Templates
1598 </a>
1599 </li>
1600
1601
1602
1603
1604
1605
1606
1607 <li class="md-nav__item">
1608 <a href="../../../migration/wsc30/css/" class="md-nav__link">
1609 CSS
1610 </a>
1611 </li>
1612
1613
1614
1615
1616
1617
1618
1619 <li class="md-nav__item">
1620 <a href="../../../migration/wsc30/package/" class="md-nav__link">
1621 Package Components
1622 </a>
1623 </li>
1624
1625
1626
1627 </ul>
1628 </nav>
1629 </li>
1630
1631
1632
1633
1634
1635
1636
1637
1638 <li class="md-nav__item md-nav__item--nested">
1639
1640
1641 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6_5" type="checkbox" id="__nav_6_5" >
1642
1643 <label class="md-nav__link" for="__nav_6_5">
1644 Migrating from WCF 2.1
1645 <span class="md-nav__icon md-icon"></span>
1646 </label>
1647 <nav class="md-nav" aria-label="Migrating from WCF 2.1" data-md-level="2">
1648 <label class="md-nav__title" for="__nav_6_5">
1649 <span class="md-nav__icon md-icon"></span>
1650 Migrating from WCF 2.1
1651 </label>
1652 <ul class="md-nav__list" data-md-scrollfix>
1653
1654
1655
1656
1657
1658 <li class="md-nav__item">
1659 <a href="../../../migration/wcf21/php/" class="md-nav__link">
1660 PHP API
1661 </a>
1662 </li>
1663
1664
1665
1666
1667
1668
1669
1670 <li class="md-nav__item">
1671 <a href="../../../migration/wcf21/templates/" class="md-nav__link">
1672 Templates
1673 </a>
1674 </li>
1675
1676
1677
1678
1679
1680
1681
1682 <li class="md-nav__item">
1683 <a href="../../../migration/wcf21/css/" class="md-nav__link">
1684 CSS
1685 </a>
1686 </li>
1687
1688
1689
1690
1691
1692
1693
1694 <li class="md-nav__item">
1695 <a href="../../../migration/wcf21/package/" class="md-nav__link">
1696 Package Components
1697 </a>
1698 </li>
1699
1700
1701
1702 </ul>
1703 </nav>
1704 </li>
1705
1706
1707
1708 </ul>
1709 </nav>
1710 </li>
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722 <li class="md-nav__item md-nav__item--nested">
1723
1724
1725 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" >
1726
1727 <label class="md-nav__link" for="__nav_7">
1728 Tutorials
1729 <span class="md-nav__icon md-icon"></span>
1730 </label>
1731 <nav class="md-nav" aria-label="Tutorials" data-md-level="1">
1732 <label class="md-nav__title" for="__nav_7">
1733 <span class="md-nav__icon md-icon"></span>
1734 Tutorials
1735 </label>
1736 <ul class="md-nav__list" data-md-scrollfix>
1737
1738
1739
1740
1741
1742
1743 <li class="md-nav__item md-nav__item--nested">
1744
1745
1746 <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1" >
1747
1748 <label class="md-nav__link" for="__nav_7_1">
1749 Tutorial Series
1750 <span class="md-nav__icon md-icon"></span>
1751 </label>
1752 <nav class="md-nav" aria-label="Tutorial Series" data-md-level="2">
1753 <label class="md-nav__title" for="__nav_7_1">
1754 <span class="md-nav__icon md-icon"></span>
1755 Tutorial Series
1756 </label>
1757 <ul class="md-nav__list" data-md-scrollfix>
1758
1759
1760
1761
1762
1763 <li class="md-nav__item">
1764 <a href="../../../tutorial/series/overview/" class="md-nav__link">
1765 Overview
1766 </a>
1767 </li>
1768
1769
1770
1771
1772
1773
1774
1775 <li class="md-nav__item">
1776 <a href="../../../tutorial/series/part_1/" class="md-nav__link">
1777 Part 1
1778 </a>
1779 </li>
1780
1781
1782
1783
1784
1785
1786
1787 <li class="md-nav__item">
1788 <a href="../../../tutorial/series/part_2/" class="md-nav__link">
1789 Part 2
1790 </a>
1791 </li>
1792
1793
1794
1795
1796
1797
1798
1799 <li class="md-nav__item">
1800 <a href="../../../tutorial/series/part_3/" class="md-nav__link">
1801 Part 3
1802 </a>
1803 </li>
1804
1805
1806
1807 </ul>
1808 </nav>
1809 </li>
1810
1811
1812
1813 </ul>
1814 </nav>
1815 </li>
1816
1817
1818
1819 </ul>
1820 </nav>
1821 </div>
1822 </div>
1823 </div>
1824
1825
1826
1827 <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1828 <div class="md-sidebar__scrollwrap">
1829 <div class="md-sidebar__inner">
1830
1831 <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1832
1833
1834
1835
1836
1837 <label class="md-nav__title" for="__toc">
1838 <span class="md-nav__icon md-icon"></span>
1839 Table of contents
1840 </label>
1841 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1842
1843 <li class="md-nav__item">
1844 <a href="#components" class="md-nav__link">
1845 Components
1846 </a>
1847
1848 <nav class="md-nav" aria-label="Components">
1849 <ul class="md-nav__list">
1850
1851 <li class="md-nav__item">
1852 <a href="#actionclassname" class="md-nav__link">
1853 &lt;actionclassname&gt;
1854 </a>
1855
1856 </li>
1857
1858 <li class="md-nav__item">
1859 <a href="#pages" class="md-nav__link">
1860 &lt;pages&gt;
1861 </a>
1862
1863 </li>
1864
1865 <li class="md-nav__item">
1866 <a href="#showorder" class="md-nav__link">
1867 &lt;showorder&gt;
1868 </a>
1869
1870 </li>
1871
1872 </ul>
1873 </nav>
1874
1875 </li>
1876
1877 <li class="md-nav__item">
1878 <a href="#example" class="md-nav__link">
1879 Example
1880 </a>
1881
1882 </li>
1883
1884 </ul>
1885
1886 </nav>
1887 </div>
1888 </div>
1889 </div>
1890
1891
1892 <div class="md-content" data-md-component="content">
1893 <article class="md-content__inner md-typeset">
1894
1895
1896
1897 <h1 id="clipboard-action-package-installation-plugin">Clipboard Action Package Installation Plugin<a class="headerlink" href="#clipboard-action-package-installation-plugin" title="Permanent link">#</a></h1>
1898 <p>Registers clipboard actions.</p>
1899 <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">#</a></h2>
1900 <p>Each clipboard action is described as an <code>&lt;action&gt;</code> element with the mandatory attribute <code>name</code>.</p>
1901 <h3 id="actionclassname"><code>&lt;actionclassname&gt;</code><a class="headerlink" href="#actionclassname" title="Permanent link">#</a></h3>
1902 <p>The name of the class used by the clipboard API to process the concrete action.
1903 The class has to implement the <code>wcf\system\clipboard\action\IClipboardAction</code> interface, best by extending <code>wcf\system\clipboard\action\AbstractClipboardAction</code>.</p>
1904 <h3 id="pages"><code>&lt;pages&gt;</code><a class="headerlink" href="#pages" title="Permanent link">#</a></h3>
1905 <p>Element with <code>&lt;page&gt;</code> children whose value contains the class name of the controller of the page on which the clipboard action is available.</p>
1906 <h3 id="showorder"><code>&lt;showorder&gt;</code><a class="headerlink" href="#showorder" title="Permanent link">#</a></h3>
1907 <p><span class="label label-info">Optional</span></p>
1908 <p>Determines at which position of the clipboard action list the action is shown.</p>
1909 <h2 id="example">Example<a class="headerlink" href="#example" title="Permanent link">#</a></h2>
1910 <div class="highlight"><pre><span></span><code><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
1911 <span class="nt">&lt;data</span> <span class="na">xmlns=</span><span class="s">&quot;http://www.woltlab.com&quot;</span> <span class="na">xmlns:xsi=</span><span class="s">&quot;http://www.w3.org/2001/XMLSchema-instance&quot;</span> <span class="na">xsi:schemaLocation=</span><span class="s">&quot;http://www.woltlab.com http://www.woltlab.com/XSD/2019/clipboardAction.xsd&quot;</span><span class="nt">&gt;</span>
1912 <span class="nt">&lt;import&gt;</span>
1913 <span class="nt">&lt;action</span> <span class="na">name=</span><span class="s">&quot;delete&quot;</span><span class="nt">&gt;</span>
1914 <span class="nt">&lt;actionclassname&gt;</span>wcf\system\clipboard\action\ExampleClipboardAction<span class="nt">&lt;/actionclassname&gt;</span>
1915 <span class="nt">&lt;showorder&gt;</span>1<span class="nt">&lt;/showorder&gt;</span>
1916 <span class="nt">&lt;pages&gt;</span>
1917 <span class="nt">&lt;page&gt;</span>wcf\acp\page\ExampleListPage<span class="nt">&lt;/page&gt;</span>
1918 <span class="nt">&lt;/pages&gt;</span>
1919 <span class="nt">&lt;/action&gt;</span>
1920 <span class="nt">&lt;action</span> <span class="na">name=</span><span class="s">&quot;foo&quot;</span><span class="nt">&gt;</span>
1921 <span class="nt">&lt;actionclassname&gt;</span>wcf\system\clipboard\action\ExampleClipboardAction<span class="nt">&lt;/actionclassname&gt;</span>
1922 <span class="nt">&lt;showorder&gt;</span>2<span class="nt">&lt;/showorder&gt;</span>
1923 <span class="nt">&lt;pages&gt;</span>
1924 <span class="nt">&lt;page&gt;</span>wcf\acp\page\ExampleListPage<span class="nt">&lt;/page&gt;</span>
1925 <span class="nt">&lt;/pages&gt;</span>
1926 <span class="nt">&lt;/action&gt;</span>
1927 <span class="nt">&lt;action</span> <span class="na">name=</span><span class="s">&quot;bar&quot;</span><span class="nt">&gt;</span>
1928 <span class="nt">&lt;actionclassname&gt;</span>wcf\system\clipboard\action\ExampleClipboardAction<span class="nt">&lt;/actionclassname&gt;</span>
1929 <span class="nt">&lt;showorder&gt;</span>3<span class="nt">&lt;/showorder&gt;</span>
1930 <span class="nt">&lt;pages&gt;</span>
1931 <span class="nt">&lt;page&gt;</span>wcf\acp\page\ExampleListPage<span class="nt">&lt;/page&gt;</span>
1932 <span class="nt">&lt;/pages&gt;</span>
1933 <span class="nt">&lt;/action&gt;</span>
1934 <span class="nt">&lt;/import&gt;</span>
1935 <span class="nt">&lt;/data&gt;</span>
1936 </code></pre></div>
1937
1938
1939
1940
1941
1942
1943
1944 </article>
1945 </div>
1946 </div>
1947 </main>
1948
1949
1950 <footer class="md-footer">
1951
1952 <nav class="md-footer__inner md-grid" aria-label="Footer">
1953
1954 <a href="../box/" class="md-footer__link md-footer__link--prev" rel="prev">
1955 <div class="md-footer__button md-icon">
1956 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
1957 </div>
1958 <div class="md-footer__title">
1959 <div class="md-ellipsis">
1960 <span class="md-footer__direction">
1961 Previous
1962 </span>
1963 box
1964 </div>
1965 </div>
1966 </a>
1967
1968
1969 <a href="../core-object/" class="md-footer__link md-footer__link--next" rel="next">
1970 <div class="md-footer__title">
1971 <div class="md-ellipsis">
1972 <span class="md-footer__direction">
1973 Next
1974 </span>
1975 coreObject
1976 </div>
1977 </div>
1978 <div class="md-footer__button md-icon">
1979 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
1980 </div>
1981 </a>
1982
1983 </nav>
1984
1985 <div class="md-footer-meta md-typeset">
1986 <div class="md-footer-meta__inner md-grid">
1987 <div class="md-footer-copyright">
1988
1989 <div class="md-footer-copyright__highlight">
1990 Copyright © 2020 WoltLab GmbH
1991 </div>
1992
1993 Made with
1994 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1995 Material for MkDocs
1996 </a>
1997
1998 </div>
1999 <div class="md-footer-copyright">
2000 <a href="https://www.woltlab.com/legal-notice/">Legal Notice</a>
2001 <a href="https://www.woltlab.com/privacy-policy/">Privacy Policy</a>
2002 </div>
2003 </div>
2004 </div>
2005 </footer>
2006
2007 </div>
2008 <div class="md-dialog" data-md-component="dialog">
2009 <div class="md-dialog__inner md-typeset"></div>
2010 </div>
2011 <script id="__config" type="application/json">{"base": "../../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing"}, "search": "../../../assets/javascripts/workers/search.fb4a9340.min.js", "version": {"provider": "mike"}}</script>
2012
2013
2014 <script src="../../../assets/javascripts/bundle.5cf3e710.min.js"></script>
2015
2016
2017 </body>
2018 </html>