Older Newer
Sat, 08 Dec 2007 12:24:30 . . . . afh [Add updateProgress to example.]


Changes by last author:

Added:
= ForEveryRow =

:(not yet implemented)

== Syntax ==

:ForEveryRow: (<compound-statement>)?

== Return ==

:true if processing is complete for this row, else false if the ForEveryPixel handler should be called next for individual processing of each pixel in this row.

== Description ==

:If the ForEveryTile handler returns false. then this handler will be called for every row in the current tile, from top to bottom. This handler is a good place to call the testAbort or updateProgress function.

== Default handler ==

:The default ForEveryRow handler simply calls updateProgress to update the progress bar and test for an abort condition, and then returns false, passing control to the ForEveryPixel handler for every pixel in this row.

== Example ==

<code>

ForEveryRow: {

updateProgress(row, rows); /* update progress bar */

return true; /* processsing complete for this row */

}

</code>

== Also see ==

:ForEveryTile, ForEveryPixel, handlers

== Comments ==

:Everyone can add his/her comments about this handler here. Tips for using it are welcome, too.