home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 June / CHIP_CD_2004-06.iso / software / miranda_hit / files / popup.mir / readme_popup.txt < prev    next >
Encoding:
Text File  |  2004-04-06  |  12.7 KB  |  276 lines

  1. PopUp plugin, v.1.0.1.9
  2.    by Luca "Hrk" Santarelli
  3.    hrk@users.sf.net
  4.  
  5. - IMPORTANT -
  6.  
  7. Developers, read m_popup.h. It's both in the source and in the binary package.
  8.  
  9.  
  10. - SUPPORTED PLUGINS -
  11.  
  12. PLEASE, read here!
  13.  
  14. PluginName        Minimum Required Version
  15. NewStatusNotify        1.1.1.5
  16. Winamp Notify        1.5
  17. NewEventNotify        x.x.x.x
  18. WhoIsReading[...]Notify        x.x.x.x
  19. EmotIcon        x.x.x.x
  20. YAHOO protocol        x.x.x.x
  21. modified MSN protocol        x.x.x.x
  22. Weather        x.x.x.x
  23. NotifyAnything     x.x.x.x
  24. ...    x.x.x.x
  25.  
  26. - LATEST CHANGE -
  27.  
  28. 1.0.2.0 Fix: library is more robust to lazy developers (thanks to GHazan for pointing it out)
  29.           Change: some code cleaning for the popup list and popup show routines.
  30.           New: decreased thread priority, PopUp will probably use less CPU.
  31.  
  32.  
  33. - KNOWN BUGs -
  34.  
  35. There are NO known bugs.
  36. Oh well... except for the multithreading issue ("Concurrent PopUps").
  37. If you get strange crashes with "Concurrent PopUps" on, disable it.
  38.  
  39.  
  40. - INFORMATIONS (you can skip this, but you can read it too!) -
  41.  
  42. Hi :-)
  43.  
  44. This plugin is the son of NewStatusNotify.
  45. You can use it even if you don't use NewStatusNotify, and probably you're here
  46. because some other plugin has "PopUp Plugin" as requirement. :-)
  47.  
  48. This lets you have all the popups at the same place, being them status
  49. notifications, previewed messages, WinAmp song titles or whatever the plugin
  50. you installed does. :-)
  51.  
  52. Should I feel that way, I'll make it so that you can have popups of different
  53. plugins in different places but... do you really need it?
  54.  
  55.  
  56. - USAGE -
  57.  
  58. Open the options page and make your choices. You can choose:
  59. -> where to have the popup Window. Either one of the corners or the center of
  60.    the screen, but in this case the windows will appear cascaded (like the
  61.    old SplitMsgDialog Plugin or StatusFloater) instead of spreading.
  62.    You can spread them vertically or horizontally.
  63.  
  64. -> Display hour and minute in the popup (thanks to the author of StatusFloater
  65.    for the cool idea!). You can have an "AM/PM" style too.
  66.  
  67. -> Choose which style the popup should have. Border, size, second line...
  68.  
  69. -> Set the interval for the popup windows to live (;-)).
  70.  
  71. -> Choose the font used in the popups, and if you wish the name to be in bold
  72.    or not. Oh, you can choose the colour too.
  73.  
  74. -> Color of the background too, obviously.
  75.  
  76. -> And the default Windows' color too, obviously :-)
  77.  
  78. -> Choose to have a fixed size popup, or a dynamically sizing popup: this means
  79.    that if the contact shown has a small nick and status text, the popup will be
  80.    small. If the contact shown has a long nick or long status text, the popup
  81.    will be large enough for the text not to be cut/clipped! :-)
  82.    No more clipped text! [except for "Latin"/"Serif" fonts like MS Sans Serif]
  83.  
  84. -> If you enabled the resizing of PopUps, but sometimes they're too small for
  85.     your tastes, you can choose to have a "Minimum width", which will avoid too
  86.     small PopUps. Same goes with "Maximum width".
  87.  
  88. -> Plugin works with "Large Fonts" systems and "Other..." systems too. It has
  89.    problems with "Serif" family fonts :-( (they get cut sometimes) but...
  90.  
  91. -> ... you can nevertheless enlarge the PopUps by a choosen % value, avoiding
  92.    this annoying thing. :) [suggested is 105%, but read FAQ]
  93.  
  94. -> Transparency. Should I add more? ;-) "Just slide the slider!"
  95.  
  96. -> Animations, Fade in, Fade out! :-)
  97.  
  98.  
  99. - ROADMAP - (or: gee, what's next?)
  100.  
  101. * Anything you think useful. :-)
  102.  
  103.  
  104. - TRANSLATION -
  105.  
  106. The strings you can translate are in a separate file, made for people who don't
  107. use a langpack file. Just copy what you need. :)
  108.  
  109.  
  110. - CHANGES -
  111.  
  112. 1.0.2.0 Fix: library is more robust to lazy developers (thanks to GHazan for pointing it out)
  113.           Change: some code cleaning for the popup list and popup show routines.
  114.           New: decreased thread priority, PopUp will probably use less CPU.
  115.  
  116. 1.0.1.9 New: plugins can choose a custom timeout or no timeout at all (using
  117.         the new POPUPDATAEX structure and MS_POPUP_ADDPOPUPEX function).
  118.         New: PopUp plugin can be totally disabled depending on status (thanks
  119.         to MatriX's help).
  120.         Fix: Delphi/Pascal headers (m_popup_inc) had a mistake which caused
  121.         Access Violations. It has now be fixed. :-)
  122.         Change: "General Options" has been moved to "PopUps" page.
  123.         Fix: some sentences were missing in the langpack (andreas)
  124.         New: added support for Miranda Installer/Wassup by Tornado.
  125.  
  126. 1.0.1.8 Fix: PopUps still running when Miranda is closed will now be cleanly
  127.          destroyed and memory freed. (This could prevent some crashes and could
  128.          just do nothing...)
  129.          New: Custom fade in and out delays.
  130.          Change: transparency percentage acts now like Miranda's one (thus
  131.          showing opacity and not transparency).
  132.          Fix: maximum width and minimum width were loaded wrongly.
  133.  
  134. 1.0.1.7 Fix: maximum and minimum width were saved wrongly.
  135.          Source will not be released due to lazyness. :)
  136.  
  137. 1.0.1.6 Fix: position, style and spreading option bug. Configure them again,
  138.          the old values had to be deleted.
  139.  
  140. 1.0.1.5 Fix: bug of wrong resize of popups when AM/PM is enabled.
  141.          Source for will not be released (I won't ever forget this bugfix...)
  142.  
  143. 1.0.1.4 New: multiline popups. :-)
  144.         Change: reordered general options dialog.
  145.         Fix: threads weren't killed if too much popups were created.
  146.         Change: PopUpList_Show() consumes less memory.
  147.         Change/Fix: made PUShowMessage() work better with single lined popups.
  148.         Change: translators, something changed. :)
  149. 1.0.1.3 Fix: concurrent popups should work fine. They do here. :)
  150.         Fix: removed some debug code left in 1.0.1.2
  151.  
  152. 1.0.1.2 New: added a menu item to enable/disable every popup depending on PopUp
  153.         plugin. Note that this will not affect other plugins, but will only
  154.         disable *popups*. If you don't want to get status notification (as
  155.         example) and you have NewStatusNotify, you have to disable
  156.         NewStatusNotify too or you'll see no popups but you will hear the
  157.         sounds!
  158.         New: MS_POPUP_QUERY service for developers. You can enable/disable
  159.         every popup with it.
  160.         New: added an advanced option to enable/disable Concurrent PopUps. Open
  161.         FAQ.txt and read the documentation. :-)
  162.         Fix: some crashes should be fixed even if "Concurrent PopUps" is on.
  163.         Fix: some names weren't shown due to a bug in CreateWindow() API. It
  164.         has been fixed thanks to Vassily Goissa (vgoissa).
  165.         New: added a m_popup.inc for Delphi developers. Thanks to egodust.
  166.  
  167. 1.0.1.1 Fix: thanks to Tornado and BGMonster a memory leak has been removed.
  168.  
  169. 1.0.1.0 New/Fix: while working on multiline popups, when the text will be two
  170.         lines (or more) long, a "..." will be appended to the first line, and
  171.         the popup will be rightly sized. Just try it with NewEventNotify or
  172.         NewStatusNotify.
  173.         Fix: MultiMonitor was broken in latest release, it now works again. [If
  174.         you need UNICODE support, recompile the plugin with #define UNICODE]
  175.  
  176. 1.0.0.9 Fix: plugin will now load under WinNT and Win95. Problem was related to MultiMonitor options.
  177.         Fix: MultiMonitor options will now be enabled only if there is a multimonitor setup. :-)
  178.         Fix: "RegOpenKeyEx()" error fixed in NT platforms (9x weren't affected).
  179.         Fix: custom maximum width and minimum width weren't properly saved.
  180.         New: PUChangeText() resizes plugin (if dinamic resize is enabled). 
  181.         This means you'll get a resizing popup with NewStatusNotify and
  182.         automatic read of away messages.
  183.         Change: many small changes, don't ask me to remember them :-)
  184.  
  185. 1.0.0.8 Bug fix release.
  186.         Fix: \r\n are not displayed correctly (which means not displayed!!)
  187.         Fix: threads not being killed :-)
  188.         Fix: Use Windows Colours wasn't working outisde of preview.
  189.         Fix: Default colours weren't saved on Miranda close.
  190.         Fix: custom maximum width wasn't saved on Miranda close.
  191.  
  192. 1.0.0.7 Fix: no more crashes on "Always on Top" failing (I hope).
  193.         Change: the new translation string (the error message) has been changed
  194.         a little, excuse me. :-) This time is final, though.
  195.         New: option to specify custom minimum width in popups.
  196.         New: option to specify a custom maximum width in popups (NewEventNotify
  197.         can show very large popups!)
  198.         New: multimonitor support. (wheee!)
  199.         New: new service added (for developers) MS_POPUP_CHANGETEXT. :-) This
  200.         will come in use to NewStatusNotify as soon as I code the preview of
  201.         away messages. Oh, what a lame, I've already done it :-P Check out
  202.         NSN 1.1.0.8
  203.         New: new message added (for developers) UM_INITPOPUP. This is sent when
  204.         a popup has completely been created, so your PluginData will be
  205.         available to you.
  206.         New: (for developers) some quick functions to avoid typing
  207.         CallService(...) ;-)
  208.         Fix: if the second line text is not given, but the popups are to have a
  209.         second line, a blank one will be drawn (currently the popup shows with
  210.         one line only)
  211.  
  212. 1.0.0.6 Fix: Reorder PopUps wasn't working due to a mistake in the fixing of
  213.         "Always on top". :-) Donwload this update because it could fix other
  214.         bugs in the showing of PopUps.
  215.         Change: the new translation string (the error message) has been changed
  216.         a little, excuse me. :-)
  217.  
  218. 1.0.0.5 New: (for developers) a new service function: PUShowMessage(), read
  219.         the documentation. Oh, read it nevertheless, since I slightly modified
  220.         the code examples. Be sure not to malloc() your POPUPDATA structure!
  221.         Fix: Thread & Handles memory leaks are now gone. There's a 2KB leak
  222.         sometimes, but I don't know if it's related to PopUp plugin or
  223.         something else. (Thanks to Kenneth)
  224.         Fix: popups are always on top for the two people who had problems too.
  225.         :-) (thanks to wintime98)
  226.         Change: small tweaks here and there.
  227.         Change: GUI improvements 8-) Options are less cluttered now... (thanks
  228.         Lynlimz)
  229.  
  230. 1.0.0.4 Fix: "always on top" was not working during fade in, but only after the
  231.         fade had completed. (Strange, it caused troubles in the old days of
  232.         NewStatusNotify, now it just works fine :-/ bah...)
  233.         Improvement: decreased CPU usage during fadings (in/out)... open Task
  234.         Manager and relax ;-) (thanks to Alex Sanyukovitch for the Sleep() hint).
  235.         Improvement: decreased memory usage and leaks, but there seems to be a
  236.         memory leak I can't fix (read readme_popup.txt && faq_popup.txt)
  237.         New: minimum width option to avoid too small PopUps.
  238.         Change: buttons and checkboxes now reflect Miranda standard ones.
  239.         Fix: Sample text font bug (it showed incorrectly sometimes).
  240.  
  241. 1.0.0.3 Fixed an issue related to Winamp Notify (my fault, not his), please
  242.         update NSN and WAN as soon as a new release is available.
  243.         Fixed "Reorder PopUps" option not being correctly saved.
  244.  
  245. 1.0.0.2 Users: MultiThreading now works! :-) PopUps are now concurrent. :-)
  246.         Developers: you'll need to compile your plugins with the new m_popup.h
  247.         Users: added the option to have "fixed position" popups, which means
  248.         they will not be reordered as every one dies.
  249.         Developers:Added a service (MS_POPUP_ISSECONDLINESHOWN)
  250.  
  251. 1.0.0.1 Fixed a GDI leak (thanks to Alex Sanyukovitch)
  252.         Removed the "MultiThreaded" checkbox. It's not yet the right time :-)
  253.  
  254. 1.0.0.0 Initial release. This plugin is "son" of NewStatusNotify. Developers,
  255.         you don't need to download the source code. Anyway, it's available.
  256.  
  257.  
  258. - DISCLAIMER -
  259.  
  260. This plugin works just fine on my machine, it should work just fine on yours
  261. withouth conflicting with other plugins. Should you have any trouble, write me
  262. at hrk@users.sf.net where "sf" must be changed to "sourceforge".
  263. Anyway, if you are a smart programmer, give a look at the code and tell me
  264. the changes you'd make. If I like them, I'll put them inside giving you the
  265. right credit! :-)
  266.  
  267. This plugin is released under the GPL license, I'm too lazy to copy it, though.
  268. Anyway, if you do have Miranda (and you should, otherwise this plugin is
  269. pretty useless) you already have a file called GPL.txt with tis license.
  270. Being GPLed you are free to modify or change the source code (you can find it
  271. here: http://nortiq.com/miranda/ and look for the source section) but you
  272. must make your sources available if asked.
  273. As I already wrote: if you do modify it, notify me, I don't see a good reason
  274. not to share the improvements with the Miranda community. :-)
  275.  
  276. Yes, I have made a quite long disclaimer, I can save the file now. :-)