1Prima::HelpViewer(3) User Contributed Perl Documentation Prima::HelpViewer(3)
2
3
4
6 Prima::HelpViewer - the built-in pod file browser
7
9 The module presents two packages, "Prima::HelpViewer" and
10 "Prima::PodViewWindow". Their sole purpose is to serve as a mediator
11 between "Prima::PodView" package, the toolkit help interface and the
12 user. "Prima::PodViewWindow" includes all the user functionality,
13 including ( but not limited to :) text search, color and font setup,
14 printing etc. "Prima::HelpViewer" provides two methods - "open" and
15 "close", used by "Prima::Application" for help viewer invocation.
16
18 The browser can be used to view and print POD ( plain old documentation
19 ) files. See the command overview below for more detailed description:
20
21 File
22 Open
23 Presents a file selection dialog, when the user can select a
24 file to browse in the viewer. The file must contain POD
25 content, otherwise a warning is displayed.
26
27 Goto
28 Asks for a manpage, that is searched in PATH and the
29 installation directories.
30
31 New window
32 Opens the new viewer window with the same context.
33
34 Run Commands in this group call external processes
35
36 prima-class
37 prima-class is Prima utility for displaying the widget
38 class hierachies. The command asks for Prima class to
39 display the hierachy information for.
40
41 Print
42 Provides a dialog, when the user can select the appropriate
43 printer device and its options.
44
45 Prints the current topic to the selected printer.
46
47 If "Full text view" menu item is checked, prints the whole
48 manpage.
49
50 Close window
51 Closes the window.
52
53 Close all windows
54 Closes all help viewer windows.
55
56 View
57 Increase font
58 Increases the currently selected font by 2 points.
59
60 Decrease font
61 Decreases the currently selected font by 2 points.
62
63 Full text view
64 If checked, the whole manpage is displayed. Otherwise, its
65 content is presented as a set of topic, and only one topic is
66 displayed.
67
68 Find
69 Presents a find dialog, where the user can select the text to
70 search and the search options - the search direction, scope,
71 and others.
72
73 Find again
74 Starts search for the text, entered in the last find dialog,
75 with the same search options.
76
77 Fast find
78 The following commands provide a simple vi-style text search
79 functionality - character keys ?,/,n,N bound to the commands
80 below:
81
82 Forward
83 Presents an input line where a text can be entered; the
84 text search is performed parallel to the input.
85
86 Backward
87 Same as Forward option, except that the serach direction is
88 backwards.
89
90 Repeat forward
91 Repeat the search in the same direction as the initial
92 search was being invoked.
93
94 Repeat backward
95 Repeat the search in the reverse direction as the initial
96 search was being invoked.
97
98 Setup
99 Presents a setup dialog, where the user can select appropriate
100 fonts and colors.
101
102 Go
103 Back
104 Displays the previously visited manpage ( or topic )
105
106 Forward
107 Displays the previously visited manpage ( or topic ), that was
108 left via Back command.
109
110 Up Displays the upper level topic within a manpage.
111
112 Previous
113 Moves to the previous topic within a manpage.
114
115 Next
116 Moves to the next topic within a manpage.
117
118 Help
119 About
120 Displays the information about the help viewer.
121
122 Help
123 Displays the information about the usage of the help viewer
124
126 Dmitry Karasik, <dmitry@karasik.eu.org>.
127
129 This program is distributed under the BSD License.
130
131
132
133perl v5.34.1 2022-04-20 Prima::HelpViewer(3)