home *** CD-ROM | disk | FTP | other *** search
/ CyberMycha Extra 2002 March / CMEXTRA4.iso / Email / pegasus_mail_w32-402.exe / BPANEL.TXT < prev    next >
Text File  |  1999-08-09  |  16KB  |  341 lines
  1. Pegasus Mail for Windows v3.0, configurable toolbar.
  2. ---------------------------------------------------------------------
  3. Pegasus Mail System,
  4. Copyright (c) 1990-98, David Harris, All Rights Reserved.
  5.  
  6.  
  7. Under Pegasus Mail v3.0 and later, the button panel (toolbar) is
  8. configurable via simple scripts. The use of scripts is not normally
  9. intended to be exposed to end-users, and it is anticipated that a
  10. GUI-based editor will be made available at some future time. In the
  11. meantime, however, those willing to do a small amount of work with an
  12. editor can customize the toolbar to suit their needs.
  13.  
  14. Pegasus Mail maintains internal definitions for the toolbar in its
  15. resource file, WINPMAIL.DAT: these definitions are usually loaded and
  16. parsed when the toolbar is created. The user can, however, create a text
  17. file called TOOLBAR.PM in his home mailbox, containing the same scripting
  18. commands. If TOOLBAR.PM is found, it is loaded in preference to the
  19. internal resource script.
  20.  
  21. The format of the resource script in TOOLBAR.PM is simple: each line
  22. defines a single toolbar element - a button, a separator, or a combobox.
  23. Other elements may be added in future. Lines beginning with semicolon
  24. characters are regarded as comments and ignored.
  25.  
  26. Command lines have the following general form:
  27.  
  28.    <type> [other parameters]
  29.  
  30. "type" is an integer that determines the type of the toolbar item. The
  31. following values are defined:
  32.  
  33.    0    A standard 22x20 pixel bitmapped button
  34.    1    An 8-pixel separator gap
  35.    2    A combobox control
  36.  
  37. Each type of control has its own parameter list as follows:
  38.  
  39. Bitmapped buttons:
  40.  
  41.    ,<control_id>,<flags>,<bitmap_id>,<"tooltip">
  42.    "control_id"    the internal activation code for this button
  43.                    (see the list below for valid values)
  44.    "flags"         an integer, currently unused but must be 0
  45.    "bitmap_id"     the integer code for the internal bitmap for the
  46.                    button (see the list below)
  47.    "tooltip"       the tooltip text the button should display when the
  48.                    mouse lingers over it for too long. This string
  49.                    must appear in quotes.
  50.  
  51. Separators: No parameters
  52.  
  53.  
  54. Combobox controls:
  55.  
  56.    ,<control_id>,<flags>
  57.    "control_id"    the internal activation code for this button
  58.                    (see the list below for valid values)
  59.    "flags"         an integer, currently unused but must be 0
  60.  
  61.  
  62. Note that for combobox and button controls, there must be a comma between
  63. the "type" parameter and the control ID.
  64.  
  65.  
  66. Control IDs:
  67.  
  68. Control IDs are internal tags used to tie a button to a given internal
  69. function. The following control IDs are recognized:
  70.  
  71. Buttons:
  72.  
  73. 801      Start a new mail message
  74. 802      Open or re-scan the new mail folder
  75. 803      Work with mail folders
  76. 804      Work with address books
  77. 805      Work with distribution lists
  78. 806      Get a list of local users on the system
  79. 807      Edit filters applied when the new mail folder is opened
  80. 808      Open noticeboards
  81.  
  82. 820      Cut
  83. 821      Copy
  84. 822      Paste
  85.  
  86. 823      Print the current window
  87. 824      Set a font for the current window
  88. 825      Save to disk
  89. 826      Read from disk
  90.  
  91. 827      Get mail via the built-in POP3 transport
  92. 828      Send mail via the built-in SMTP transport
  93. 829      Get mail then send mail
  94. 835      Perform a selective download via the built-in POP3 transport
  95.  
  96. 836      Start a new circulation message.
  97. 838      Switch to the folder manager window and add a mailbox
  98.  
  99. Comboboxes:
  100.  
  101. 840      List of currently-defined identities on the system
  102.  
  103. You can create a button that triggers any standard menu item in the
  104. Pegasus Mail menu hierarchy by adding 10000 to the menu item's code (see
  105. Appendix A, below) then using that value as the button's control ID.
  106.  
  107.  
  108.  
  109. Bitmap IDs:
  110.  
  111. A number of bitmaps are built-in to Pegasus Mail and can be accessed in
  112. buttons via special bitmap IDs. The following IDs are available: note
  113. that the text describing each button is simple description - the control
  114. ID is what decides what function is actually associated with a button.
  115.  
  116. 1801      Start a new mail message
  117. 1802      Open or re-scan the new mail folder
  118. 1803      Work with mail folders
  119. 1804      Work with address books
  120. 1805      Work with distribution lists
  121. 1806      Get a list of local users on the system
  122. 1807      Edit filters applied when the new mail folder is opened
  123. 1808      Open noticeboards
  124.  
  125. 1820      Cut
  126. 1821      Copy
  127. 1822      Paste
  128.  
  129. 1823      Print the current window
  130. 1824      Set a font for the current window
  131. 1825      Save to disk
  132. 1826      Read from disk
  133.  
  134. 1827      Get mail via the built-in POP3 transport
  135. 1828      Send mail via the built-in SMTP transport
  136. 1829      Get mail then send mail
  137.  
  138. 1830      Connect/go online
  139. 1831      Disconnect/go offline
  140.  
  141. 1835      Perform a selective download via the built-in POP3 transport
  142.  
  143. 1836      Start a new circulation message.
  144. 1837      Open a saved message
  145. 1838      Mount a secondary mailbox
  146. 1839      Tools | Options
  147. 1840      Identities
  148. 1841      Review queued mail
  149. 1842      Find...
  150. 1843      Asterisk
  151. 1844      Yellow document icon
  152. 1845      Blue star
  153. 1846      Apply general rule set to folder
  154.  
  155.  
  156.  
  157. Example
  158.  
  159. The following fragment creates a simple toolbar
  160.  
  161. 0,801,0,1801,"Compose a new mail message"
  162. 0,836,0,1836,"Create a new circulation message"
  163. 0,802,0,1802,"Open or re-scan your new mail folder"
  164. 0,803,0,1803,"Work with your mail folders"
  165. 0,804,0,1804,"Open or manage address books"
  166. 0,805,0,1805,"Edit or manage distribution (mailing) lists"
  167. 0,806,0,1806,"Open a list of local people on your system"
  168. 0,807,0,1807,"Create or manage rules for filtering your new mail"
  169. 0,808,0,1808,"Open or browse noticeboards"
  170. 1
  171. 2,840,0
  172. 1
  173. 0,823,0,1823,"Print the current window"
  174. 0,824,0,1824,"Select a font for the current window"
  175. 1
  176. 0,828,0,1828,"Send all queued mail"
  177. 0,827,0,1827,"Check your POP3 host for new mail"
  178. 0,829,0,1829,"Both check and send mail in one operation"
  179.  
  180.  
  181.  
  182. Appendix A: Menu codes for Pegasus Mail
  183.  
  184. The following integer values can be used to construct button panel
  185. entries that trigger any menu entry in the program. Add 10000 to the
  186. value shown, then use that value as the button's control ID.
  187.  
  188. ------------------------------------------------------------------------
  189. WinPMail Mnemonic       ID    Menu function (Which Menu)
  190. ------------------------------------------------------------------------
  191. IDM_HELP                10    "Context-sensitive help" (HELP)
  192. IDM_USING_HELP          11    "Using Help" (HELP)
  193. IDM_HELPINDEX           12    "Help index" (HELP)
  194. IDM_RMACRO              75    "Open glossary manager" (EDIT/GLOSSARY)
  195. IDM_PMACRO              76    "Expand glossary entry" (EDIT/GLOSSARY)
  196. IDM_NEWMESSAGE         101    "Start new message" (FILE)
  197. IDM_READNEW            102    "Open new mail folder" (FILE)
  198. IDM_OPENFOLDER         103    "Folders..." (FILE)
  199. IDM_IMPORT             104    "Import into message" (MESSAGE)
  200. IDM_SAVESESSION        105    "Save message as draft" (MESSAGE)
  201. IDM_RESTORESESSION     106    "Open saved message" (FILE)
  202. IDM_PRINT              107    "Print" (FILE)
  203. IDM_PRINTSETUP         109    "Printer setup" (FILE)
  204. IDM_FILTERS            110    "New mail filtering rules" (FILE)
  205. IDM_EXIT               111    "Exit" (FILE)
  206. IDM_PREF_GENERAL       121    "General settings" (FILE/PREFS)
  207. IDM_PREF_SMF           122    "NetWare MHS settings" (FILE/PREFS)
  208. IDM_PREF_SIGS          123    "Signatures..." (FILE/PREFS)
  209. IDM_PREF_HOMEBOX       124    "Home mailbox location" (FILE/PREFS)
  210. IDM_PREF_EXT           125    "Extended features" (FILE/PREFS)
  211. IDM_UNDO               131    "Undo" (EDIT)
  212. IDM_CUT                132    "Cut" (EDIT)
  213. IDM_COPY               133    "Copy" (EDIT)
  214. IDM_PASTE              134    "Paste" (EDIT)
  215. IDM_CLEAR              135    "Clear" (EDIT)
  216. IDM_SELECTALL          136    "Select all" (EDIT)
  217. IDM_SPELLING           137    "Check spelling" (EDIT)
  218. IDM_SERVER             138    "File servers..." (FILE)
  219. IDM_LOCALUSERS         141    "Lookup local users" (ADDRESSES)
  220. IDM_ADDRESSBOOKS       142    "Address books" (ADDRESSES)
  221. IDM_MAILINGLISTS       143    "Distribution lists..." (ADDRESSES)
  222. IDM_SORTBYKEY          144    "Sort by key" (ADDRESSBOOK)
  223. IDM_SORTBYNAME         145    "Sort by name" (ADDRESSBOOK)
  224. IDM_FIND               146    "Find text", (MESSAGE/FOLDER/READER/ADDRBK)
  225. IDM_FINDAGAIN          147    "Find again", (MESSAGE/FOLDER/READER/ADDRBK)
  226. IDM_PASTENAMES         148    "Paste names" (ADDRESSBOOK)
  227. IDM_PASTEADDRESSES     149    "Paste addresses" (ADDRESSBOOK)
  228. IDM_SAVESIZE           150    "Save window size" (Various)
  229. IDM_OTHEROPTIONS       151    "Special message view" (MESSAGE)
  230. IDM_SHOWHEADERS        153    "Show all headers" (READER)
  231. IDM_EXTRACT            154    "Save messages to disk" (FOLDER/READER)
  232. IDM_ATTACH             155    "Switch to attachments view" (MESSAGE)
  233. IDM_MARKUNREAD         156    "Mark message as unread" (FOLDER and NB)
  234. IDM_ALIASING           157    "Resolve aliases" (ADDRESSBOOK)
  235. IDM_BPPREF             158    "Button panel preferences" (FILE/PREFS)
  236. IDM_UUDECODE           160    "UUdecode message" (FOLDER/READER /SPECIAL)
  237. IDM_UNBINHEX           161    "Un-BinHex message" (FOLDER/READER /SPECIAL)
  238. IDM_LOCALSIG           162    "Signature for local mail" (FILE/PREFS)
  239. IDM_INETSIG            163    "Signature for Internet mail" (FILE/PREFS)
  240. IDM_MHSSIG             164    "Signature for MHS mail" (FILE/PREFS)
  241. IDM_DELEXPIRED         165    "Delete expired messages" (FOLDER/SPECIAL)
  242. IDM_EDMAIL             167    "Switch to message editor view" (MESSAGE)
  243. IDM_QUICKLOOKUP        168    "Quick lookup" (ADDRESSES)
  244. IDM_WORDWRAP           169    "Reformat long lines" (READER)
  245. IDM_DELLINE            170    "Delete line" (MESSAGE)
  246. IDM_REFORMAT           171    "Reformat paragraph" (MESSAGE)
  247. IDM_INDENT             172    "Indent text" (MESSAGE)
  248. IDM_REPLACE            173    "Search and replace" (MESSAGE)
  249. IDM_DELWORD            174    "Delete word right" (MESSAGE)
  250. IDM_APREFS             175    "Advanced settings" (FILE/PREFS)
  251. IDM_ENLARGE            176    "Enlarge window" (WINDOW)
  252. IDM_ABK_EXPORT         177    "Export addressbook" (ADDRESSBOOK)
  253. IDM_ABK_IMPORT         178    "Import addressbook" (ADDRESSBOOK)
  254. IDM_NOTICEBOARDS       179    "Noticeboards" (FILE)
  255. IDM_ANN_EDIT           180    "Add/edit annotation" (FOLDER)
  256. IDM_SRT_DATE           270    "Sort by date" (FOLDER)
  257. IDM_SRT_REVDATE        271    "Sort by reverse date" (FOLDER)
  258. IDM_SRT_SUBJECT        272    "Sort by subject" (FOLDER)
  259. IDM_SRT_FROM           273    "Sort by sender's name" (FOLDER)
  260. IDM_SRT_SUBJECT2       274    "Sort by subject/reverse date" (FOLDER)
  261. IDM_SRT_COLOUR         275    "Sort by colour" (FOLDER)
  262. IDM_FORMS              185    "Open Forms Manager" (FILE)
  263. IDM_ANN_DELETE         186    "Delete annotation" (FOLDER)
  264. IDM_REVIEWMAIL         187    "Review Queued Mail" (FILE)
  265. IDM_TODISK             230    "Save to disk" (Various)
  266. IDM_FROMDISK           231    "Read from disk" (Various)
  267. IDM_EXTRACTFILE        240    "MHS directory service" (ADDRESSES)
  268. IDM_LOGGED_IN          241    "Logged-in users" (ADDRESSES)
  269. IDM_ADD_USER           242    "Add sender to list" (READER/SPECIAL)
  270. IDM_REMOVE_USER        243    "Remove sender from list" (READER/SPECIAL)
  271. IDM_FONT               299    "Font" (Various)
  272. IDM_TILE               500    "Tile" (WINDOW)
  273. IDM_CASCADE            501    "Cascade" (WINDOW)
  274. IDM_ARRANGEICONS       502    "Arrange Icons" (WINDOW)
  275. IDM_BUTTONPANEL        503    "Button panel" (WINDOW)
  276. IDM_NETCONFIG          210    "Network Configuration" (FILE)
  277. IDM_GETMAIL            211    "Check host for new mail" (FILE)
  278. IDM_SENDMAIL           212    "Send all queued mail" (FILE)
  279. IDM_GETANDSEND         189    "Check and send mail" (FILE)
  280.  
  281. IDM_MSGCOLOUR          260    "Set colour" (FOLDER)
  282. IDM_UADMIN             322    "Manage users..." (ADDRESSES)
  283. IDM_ONLINE             321    "Leave offline mode" (FILE)
  284. IDM_OFFLINE            320    "Enter offline mode" (FILE)
  285. IDM_QF_6               316    "Quick folder 6" (FILE/FOLDERS)
  286. IDM_QF_5               315    "Quick folder 5" (FILE/FOLDERS)
  287. IDM_QF_4               314    "Quick folder 4" (FILE/FOLDERS)
  288. IDM_QF_3               313    "Quick folder 3" (FILE/FOLDERS)
  289. IDM_QF_2               312    "Quick folder 2" (FILE/FOLDERS)
  290. IDM_QF_1               311    "Quick folder 1" (FILE/FOLDERS)
  291. IDM_QF_DEFINE          197    "Define quick folders" (FILE/FOLDERS)
  292. IDM_EDIT_FLAGS         199    "Edit message flags" (FOLDER)
  293. IDM_SRT_NEWTOTOP       198    "Sort unread before read" (FOLDER)
  294. IDM_DLM_EXPORT         196    "Export to text file" (LISTS)
  295. IDM_DLM_DUPLICATE      194    "Duplicate list" (LISTS)
  296. IDM_DLM_EDIT           193    "Edit list" (LISTS)
  297. IDM_DLM_DELETE         192    "Delete list" (LISTS)
  298. IDM_DLM_ADD            191    "Add new list" (LISTS)
  299. IDM_PREF_VIEW          190    "Attachment viewers" (FILE)
  300. IDM_FULLSCREEN         188    "Enlarge message editor" (MESSAGE)
  301.  
  302. IDM_ADD_MAILBOX        330    "Add mailbox to list" (FOLDER)
  303. IDM_CHANGE_USER        249    "Change user" (FILE, standalone only)
  304. IDM_COPY_SPECIAL       360    "Copy special" (r-click in editor)
  305. IDM_CSFILTERS          112    "Edit copy-self filtering rules" (TOOLS)
  306. IDM_DISMOUNT_MBX       364    "Remove mailbox from list" (FOLDER)
  307. IDM_EDITRULES          113    "Create/edit general filter rule set" (TOOLS)
  308. IDM_EDIT_FLAGS         199    "Edit message flags" (FOLDER)
  309. IDM_FILTERSA           115    "Edit rules applied when folder closed"
  310. IDM_HELP_CMDLINE       17     "Commandline options" (HELP)
  311. IDM_HELP_DRAGDROP      16     "Help on drag and drop" (HELP)
  312. IDM_HELP_ETIQUETTE     18     "E-Mail etiquette guidelines" (HELP)
  313. IDM_HELP_HISTORY       21     "History of Pegasus Mail" (HELP)
  314. IDM_HELP_MANUALS       15     "Ordering manuals" (HELP)
  315. IDM_HELP_TANDC         20     "Terms and conditions" (HELP)
  316. IDM_HELP_TECHSUPP      14     "Technical support" (HELP)
  317. IDM_HELP_TROUBLE       13     "Troubleshooting" (HELP)
  318. IDM_HELP_WHATSNEW      22     "What's new in this version" (HELP)
  319. IDM_IDENTITIES         120    "Identities..." (TOOLS)
  320. IDM_IMAP               363    "IMAP Profiles" (TOOLS, v3.11 and later)
  321. IDM_KEY_MANAGEMENT     182    "Digital key management" (READER)
  322. IDM_LOGGING            377    "System Messages" (WINDOW, v3.12 and later)
  323. IDM_MARKREAD           244    "Mark as read" (FOLDER, r-click)
  324. IDM_MARKREADONLY       340    "Toggle read-only state" (FOLDER, r-click)
  325. IDM_MONOFONT           245    "Switch to monospaced view" (READER/MESSAGE)
  326. IDM_NB_NEW             370    "Create new topic" (NOTICEBOARD)
  327. IDM_NB_PROPS           371    "Current topic properties" (NOTICEBOARD)
  328. IDM_NB_RESYNCH         372    "Rescan this topic" (NOTICBOARD)
  329. IDM_NOTEPAD            119    "Notepads..." (TOOLS)
  330. IDM_QUICKLOOKUP2       166    "Lookup in recently-used addresses"
  331. IDM_REDO               130    "Redo" (EDIT)
  332. IDM_REPLY_TEMPLATE     366    "Reply using a template" (FOLDER, r-click)
  333. IDM_RESEND             365    "Resend this message" (FOLDER, r-click)
  334. IDM_RESET_STYLES       246    "Reset styles" (MESSAGE, r-click)
  335. IDM_SELECT             376    "Select..." (FOLDER, v3.12 and later)
  336. IDM_SET_COLOUR         247    "Set message colour" (FOLDER/READER)
  337. IDM_SHOWHEADERS        153    "Show raw headers" (READER)
  338. IDM_VERIFY_DSIG        181    "Check for digital signature" (READER)
  339. IDM_WORDWRAP2          361    "Wrap long lines" (READER, v3.12 and later)
  340.  
  341.