1 Pixx-designed PJIRC Interface
2 -----------------------------
9 The following files are part of the Pixx GUI:
10 pixx.cab : Pixx GUI for Internet Explorer VM.
11 pixx.jar : Pixx GUI for Sun JVM.
15 Upload both files to your PJIRC directory, and add them to the file list in
16 the applet html fragment.
20 All PIXX parameters are prefixed by 'pixx:'.
22 colorI, with I a figure : Tells the applet to modify the given color index to
23 ------ the given color.
25 The following color codes are defined :
44 <param name="pixx:color1" value="C0C000">
46 helppage : configures the help page to be opened in a new browser window when
47 -------- the help button is clicked by the user on the interface.
50 <param name="pixx:helppage" value="http://www.yahoo.com">
52 timestamp : switches on or off the timestamp option. By default, timestamping
53 --------- is not activated.
56 <param name="pixx:timestamp" value="true">
58 highlight : enable or disable highlights. If highlights are not enabled, no
59 --------- highlight will be performed, regardless of any other highlight
60 option. By default, highlights are disabled.
63 <param name="highlight" value="true">
65 highlightnick : if highlight is enabled, any received message containing the
66 ------------- current user nick will be highlighted. By default, nick
67 highlight is switched off.
70 <param name="pixx:highlightnick" value="true">
72 highlightcolor : if highlight is enabled, specifies the highlight color to be
73 -------------- used. By default, highlight color is 5.
76 <param name="pixx:highlightcolor" value="9">
78 highlightwords : if highlight is enabled, gives a list of words triggering
79 -------------- highlight. Words are separated using spaces.
82 <param name="pixx:highlightwords" value="word1 word2 word3">
85 showconnect : enable or disable connect menu button visibility. By default,
86 ----------- the connect button is visible.
89 <param name="pixx:showconnect" value="true">
91 showchanlist : enable or disable chanlist menu button visibility. By default,
92 ------------ the chanlist button is visible.
95 <param name="pixx:showchanlist" value="true">
97 showabout : enable or disable about menu button visibility. By default, the
98 --------- about button is visible.
101 <param name="pixx:showabout" value="true">
103 showhelp : enable or disable help menu button visibility. By default, the
104 -------- help button is visible.
107 <param name="pixx:showhelp" value="true">
109 nicklistwidth : set the width, in pixel, of the right channels nicklist bar.
110 ------------- Default value is 130.
113 <param name="pixx:nicklistwidth" value="130">
115 nickfield : show a nick input field in the bottom right of the application.
116 --------- By default, this option is disabled.
119 <param name="pixx:nickfield" value="false">
121 styleselector : control the style selector visibility. By default, style
122 ------------- selector is not visible.
125 <param name="pixx:styleselector" value="true">
127 setfontonstyle : control the "font selector on style selector" visibility.
128 -------------- By default, the font selector is disabled.
131 <param name="pixx:setfontonstyle" value="true">
133 showclose : set whether the close box button should be visible or not. By
134 --------- default, close button is visible.
137 <param name="pixx:showclose" value="false">
139 showstatus : set whether the status window should be visible or not. By
140 ---------- default, status window is visible.
143 <param name="pixx:showstatus" value="false">
145 automaticqueries : enable or disable the automatic query popup when
146 ---------------- user double click on another nickname. By default,
147 automatic queries are enabled.
150 <param name="pixx:automaticqueries" value="false">
152 configurepopup : master switch for manual popup configuration. Must be
153 -------------- set in order to use popupmenustringI and
154 popupmenucommandI_J parameters. By default, master
155 popup configuration switch is disabled.
158 <param name="pixx:configurepopup" value="true">
160 popupmenustringI : configure the Ith line of the nickname popup menu.
161 ---------------- This parameter only set the caption, the action to
162 be performed is customized using popupmenucommandI_J.
163 A '--' caption acts as a separation line.
166 <param name="pixx:popupmenustring1" value="Whois">
167 <param name="pixx:popupmenustring2" value="Kick + Ban">
170 popupmenucommandI_J : configure the Jth command of the Ith line of the
171 ------------------- nickname popup menu. %1 will be replaced by the
172 nickname, %2 by the source name, %3 by the
173 user ASL (if available) or full name information,
174 and %4 will always be replaced by the full name
178 <param name="pixx:popupmenucommand1_1" value="/whois %1">
179 <param name="pixx:popupmenucommand2_1" value="/mode %2 -o %1">
180 <param name="pixx:popupmenucommand2_2" value="/mode %2 +b %1">
181 <param name="pixx:popupmenucommand2_3" value="/kick %2 %1">
184 mouseXXX : advanced mouse configuration for event XXX. First parameter
185 -------- is mouse button number (1=left mouse button), second is
186 number of clicks for the vent (2=double click). The following
187 mouse events are known :
188 - nickquery : query open
190 - channeljoin : channel joining
191 - nickpopup : popup menu on nickname
192 - taskbarpopup : popup menu on the bottom taskbar
195 <param name="pixx:mouseurlopen" value="3 1">
197 showchannelX : set whether the X channel event notifications should
198 ------------ be displayed on the channel. By default,
199 all notifications are displayed except youjoin.
212 <param name="pixx:showchannelnickchanged" value="false">
215 showdock : set whether the docking button should be visible or not.
216 -------- by default, the docking button is visible.
219 <param name="pixx:showdock" value="false">
221 dockingconfigI : configure the default docking behaviour for the
222 -------------- sources. By default, all sources will remain
223 undocked. Syntax is sourcetype sourcename dock
224 or sourcetype sourcename undock.
227 <param name="pixx:dockingconfig1" value="none+ChanList all undock">
229 scrollspeed : set the topic scrolling speed. A value of 0 keeps the topic
230 ----------- static. Default value is 0.
233 <param name="pixx:scrollspeed" value="20">
235 leaveonundockedwindowclose : set whether the source should be left when
236 -------------------------- the undocked window is closed. By default,
237 this is false and the source is docked back.
240 <param name="pixx:leaveonundockedwindowclose" value="true">
243 nickprefix : Defines the nickname display prefix. Escape codes can be
244 ---------- defined as following: \b toggle bold
248 \kX,Y toggle color X,Y
252 <param name="pixx:nickprefix" value="<\b">
254 nickpostfix : Defines the nickname display postfix. Escape codes can be
255 ----------- defined as following: \b toggle bold
259 \kX,Y toggle color X,Y
260 Default Value is '>\s'
263 <param name="pixx:nickpostfix" value="\b>\s">
265 displayentertexthere : Enables the "Enter text here..." text that
266 -------------------- will be displayed upon new source creation
267 in the text input field. Default value is false.
270 <param name="pixx:displayentertexthere" value="true">
272 ignoreallmouseevents : Disables any mouse-related events. By default,
273 -------------------- this is false.
276 <param name="pixx:ignoreallmouseevents" value="true">
278 hideundockedsources : Removes the undocked sources from the taskbar.
279 ------------------- By default, this is not enabled.
282 <param name="pixx:hideundockedsources" value="true">
284 displaychannelXXX : Enable or disable channel topic details.
285 ----------------- By default, all details are enabled.
286 XXX can be: name the channel name
287 mode the channel mode
289 topic the channel topic
292 <param name="pixx:displaychannelmode" value="false">
297 The Pixx gui adds some commands:
299 dock : dock the active source
300 undock : undock the active source
301 color %c : set the current color to %c. For instance /color 4,2
302 bold %b : set the bold status, with %b being either 1 or 0.
303 underline %u : set the underline status, with %u being either 1 or 0.
308 Pixx PJIRC GUI is developped by Plouf - plouf@pjirc.com
309 Have a look to http://www.pjirc.com/ for news about PJIRC.