WMSetVariableAction

WMSetVariableAction

This structure is passed to action procedures for SetVariable controls created using the SetVariable operation.

Structure WMSetVariableAction
   char ctrlName[MAX_OBJ_NAME+1]       // Control name
   char win[MAX_WIN_PATH+1]            // Host window or subwindow name
   STRUCT Rect winRect                 // Local coordinates of host window
   STRUCT Rect ctrlRect                // Enclosing rectangle of the control
   STRUCT Point mouseLoc               // Mouse location
   Int32 eventCode                     // See details below
   Int32 eventMod                      // See Control Structure eventMod Field
   String userData                     // Primary unnamed user data
   Int32 blockReentry                  // Obsolete, see Control Structure blockReentry Field
   Int32 isStr                         // TRUE for a string variable
   Variable dval                       // Numeric value of variable
   char sval[MAXCMDLEN]                // Value of variable as a string
   char vName[MAX_OBJ_NAME+2 + (MAXDIMS * (MAX_OBJ_NAME+5)) + 1]  // Name of variable or wave
   WAVE svWave                         // Valid if using wave
   Int32 rowIndex                      // Row index for a wave, if rowLabel is empty
   char rowLabel[MAX_OBJ_NAME+1]       // Wave row dimension label
   Int32 colInde                       // Column index for a wave if colLabel is empty
   char colLabel[MAX_OBJ_NAME+1]       // Wave column dimension label
   Int32 layerIndex                    // Layer index for a wave if layerLabel is empty
   char layerLabel[MAX_OBJ_NAME+1]     // Wave layer dimension label
   Int32 chunkIndex                    // Chunk index for a wave if chunkLabel is empty
   char chunkLabel[MAX_OBJ_NAME+1]     // Wave chunk dimension label
   Int32 mousePart                     // Part of the control where mouse down occurred
EndStructure

The constants used to specify the size of structure char arrays are internal to Igor Pro and may change.

WMSetVariableAction eventCode Field

Your action function should test the eventCode field and respond only to documented eventCode values because other event codes may be added in the future.

The event code passed to the SetVariable action procedure has the following meaning:

Event Code	Event
-3	Control received keyboard focus (Igor 8 or later)
-2	Control lost keyboard focus (Igor 8 or later)
-1	Control being killed
1	Mouse up
2	Enter key
3	Live update
4	Mouse scroll wheel up
5	Mouse scroll wheel down
6	Value changed by dependency update
7	Begin edit (Igor 7 or later)
8	End edit (Igor 7 or later)
9	Mouse down (Igor 8 or later)

Event code -1 is never sent to an old-style (non-structure parameter) action procedure.

Event code 1 is sent when the mouse is released after clicking the up-arrow or down-arrow buttons. It is also sent for value changes caused by the mouse scroll wheel for a non-live mode control.

Event codes 4 and 5 are sent only for string SetVariables or numeric SetVariables whose increment setting is zero. Otherwise the value change is signaled by event code 1.

For numeric SetVariables whose increment is non-zero, the mouse scroll wheel acts like a mouse click on the up-arrow button or down-arrow button. That is, event code 1, mouse up, is more like "value changed".

Event code 6 is by default sent to only structure-based action procedures.

Use SetIgorOption EnableSVE6=0 to disable sending this event at all and EnableSVE6=2 to send the event to both structure-based and old-style SetVariable action procedures. The default for EnableSVE6 is =1.

The mousePart field is valid for mouse down, mouse scroll wheel, live update, and Enter key events only:

Value	Mouse Part
0	A part other than 1, 2, or 3 – most likely the title
1	The up-arrow button on a numeric SetVariable via a mouse click on the button or the use of the up-arrow key
2	The down-arrow button on a numeric SetVariable via a mouse click on the button or the use of the down-arrow key
3	The value field