Difference between revisions of "platform.window:invalidate"

From Inspired-Lua Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ platform.window:'''invalidate''' is a function that is part of platform.window. This routine invalidates a region of the window and for...")
 
 
(4 intermediate revisions by the same user not shown)
Line 4: Line 4:
  
  
This routine invalidates a region of the window and forces it to repaint.<br />
+
This routine invalidates a region of the window by firing the [[on.paint]] event, thus forcing it get repainted.<br />
x and y default to (0, 0) and width and height default to the pixel width and height of the window.<br />
+
x and y default to (0, 0) and width and height default to the pixel width and height of the window.<br />These arguments are optional.
 +
 
 +
<br />
  
 
{{Since|3.0}}
 
{{Since|3.0}}
Line 16: Line 18:
 
! Parameter !! Type !! Description
 
! Parameter !! Type !! Description
 
|-
 
|-
| <u>x</u> || number || Description of arg1
+
| <u><center>x</center></u> || number || x-coordinate of the upper-left origin.
 
|-
 
|-
| <u>y</u> || number || Description of arg2
+
| <u><center>y</center></u> || number || y-coordinate of the upper-left origin.
 
|-
 
|-
| <u>width</u> || number || Description of arg3
+
| <u><center>width</center></u> || number || width of the region to be refreshed.
 
|-
 
|-
| <u>height</u> || number || Description of arg4
+
| <u><center>height</center></u> || number || height of the region to be refreshed.
 
|}
 
|}
  
Line 30: Line 32:
  
 
== Good to know ==
 
== Good to know ==
 +
The entire window can be forced to repaint with by calling the function with no arguments : ''platform.window:'''''invalidate'''() , allowing all parameters to take their default values.
  
The entire window can be forced to repaint with by calling the function with no arguments : ''platform.window:'''''invalidate'''() , allowing all parameters to take their default values.
+
Repainting only a part of the widget (thanks to providing the necessary arguments) only currently works on-calc, not on the software.
  
 
== See also  ==
 
== See also  ==

Latest revision as of 22:30, 7 August 2011


platform.window:invalidate is a function that is part of platform.window.


This routine invalidates a region of the window by firing the on.paint event, thus forcing it get repainted.
x and y default to (0, 0) and width and height default to the pixel width and height of the window.
These arguments are optional.


This has been introduced in TI-Nspire OS 3.0 (Changes).


Syntax

platform.window:invalidate([x, y, width, height])

Parameter Type Description
x
number x-coordinate of the upper-left origin.
y
number y-coordinate of the upper-left origin.
width
number width of the region to be refreshed.
height
number height of the region to be refreshed.

Examples

platform.window:invalidate()
platform.window:invalidate(0, 0, 50, 10)

Good to know

The entire window can be forced to repaint with by calling the function with no arguments : platform.window:invalidate() , allowing all parameters to take their default values.

Repainting only a part of the widget (thanks to providing the necessary arguments) only currently works on-calc, not on the software.

See also