hV_GUI — Text Box

TextBox is an intelligent box to display text. 

Words are wrapped and new lines inserted at the space between them. When the box is full, the text is scrolled one line up to free space on the bottom for a new empty line.

TextBox is an object with 4 functions: 
  • define, 
  • clear, 
  • scroll and 
  • print.


Declaration only requires:

    









					
										
					
						




					
							

		
	






	

		
			

				
					
						




					
								
					
						




					
							

		
	






	

		
			

				
					
						


Text is automatically formatted...



					
										
					
						


...and new lines scroll the text up.



					
									

		
	





Define



Parameters to define a text box are:




	

    

        

    

    

        

    










	

		
			

				
					
						


Required parameters
  • LCD_screen * lcd, LCD to which the button belongs, with &myLCD,
  • uint16_t x0, uint16_t y0, point x0, y0, 
  • uint16_t dx, uint16_t dy, x-width dx and y-height dy.​




					
										
					
						


Optional parameters 
  • uint8_t gridX=4, uint8_t gridY=4, number of columns and number of lines,
  • uint16_t textColour0, uint16_t backColour0 for the text and background colours
  • uint8_t size=0 defines the size of the font, with default = 0 = smallest. Size font ranges up to 2 or 3, depending on the screen.



					
									

		
	





Commands




	

		
			

				
					
						


Clear clears the box and place the cursor on top-leftmost position.



					
										
					
						



	

    

        

    

    

        

    









					
									

		
	






	

		
			

				
					
						


Scroll adds a new line to the text.

If required, the whole text is scrolled up.



					
										
					
						



	

    

        

    

    

        

    









					
									

		
	






	

		
			

				
					
						


Print prints the text to the text box, filling the lines with entire words.

Two specific sequences in the text include:
  • \n sequence adds a new line, same as scroll()
  • \r sequence clears the box, same as clear().

If required, the whole text is scrolled up.