Editing getPreviewCursor - FilterMeisterWiki

When saving, enter the following:

 _______           __     __ ___            
(  ____ )          \ \   / /(  _`\          
| (    )| ######    \ \_/ / | ( (_)  ####   
| (____)|    ###     \   /  | |___  ##  ##  
|     __)   ##        | |   | (_, ) ##      
| (\ (     ##         |_|   (____/' ##      
| ) \ \__ ###                       ##  ##  
|/   \__/ ######                     ####

Visit Preferences to set your user name

= getPreviewCursor =

== Syntax ==
{{int getPreviewCursor(void)}}

== Return ==
The integer resource number of the cursor being used.

== Description ==
Retrieves the pointer icon resource being used when the mouse is over the preview image. Typical values are
<code>
                  103  : Default Windows pointer (hand)
  IDC_ARROW    (32512) : Arrow pointer
  IDC_IBEAM    (32513) : I beam (text cursor)
  IDC_WAIT     (32514) : Busy pointer
  IDC_CROSS    (32515) : Cross
  IDC_UPARROW  (32516) : Up arrow
  IDC_SIZE     (32640) : Size pointer
  IDC_HELP     (32641) : pointer with question mark
  IDC_SIZENWSE (32642) : NWSE diagonal arrow
  IDC_SIZENESW (32643) : NESW diagonal arrow
  IDC_SIZEWE   (32644) : WE arrow
  IDC_SIZENS   (32645) : NS arrow
  IDC_SIZEALL  (32646) : Size all crossed-arrows
  IDC_NO       (32648) : NO pointer
  IDC_APPSTARTING (32650) : Application Starting pointer
  IDC_ICON     (32651) : ? custom cursor?
</code>

== Example ==
<code>
OnFilterStart: {
  // Displays preview cursor icon
  // resource number. This will
  // be 103 by default for the
  // hand icon
  Info("Preview icon resource number: %d", getPreviewCursor());
  return false;
}
</code>

== See Also ==
((setPreviewCursor))

Summary of change:
Add document to category: