DroidScript Wiki

User Tools

Site Tools

Trace:
built_in:text

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
Next revision Both sides next revision
built_in:text [2015/02/15 16:05]
octazid [Options] 		built_in:text [2016/04/29 23:05]
58.96.146.120 [Options] Added the NoWrap and Log options
Line 1: Line 1:
 ====== Text control ====== ====== Text control ======
-===== Create ===== 
-Create Text objects using the **CreateText** method of the [[app]] object: 
  
 +//(Information and examples taken from the DroidScript documentation)//
 +
 +===== Description =====
 +Create Text objects using the **CreateText** method of the **[[app]]** object:
 <code>txt = app.CreateText( text, width, height, options );</code> <code>txt = app.CreateText( text, width, height, options );</code>
 You can use the **"Multiline"** option to allow multi-line text and the **"Left"** or **"Right"** options to align the text. The default is single line centered text. You can use the **"Multiline"** option to allow multi-line text and the **"Left"** or **"Right"** options to align the text. The default is single line centered text.
  
-Use the SetText and GetText functions of the Text object to set and get it's text.+Use the **SetText** and **GetText** functions of the Text object to set and get it's text. 
 + 
 +==== Example - Single line ==== 
 +<code javascript> 
 +function OnStart() 
 +{ 
 +  lay = app.CreateLayout( "Linear", "VCenter,FillXY" ); 
 + 
 +  txt = app.CreateText( "Hello" ); 
 +  txt.SetTextSize( 22 ); 
 +  lay.AddChild( txt ); 
 + 
 +  app.AddLayout( lay ); 
 +}  
 +</code> 
 +You can change the look of a Text using the **SetBackColor** and **SetTextColor** functions on the Text object. 
 + 
 +==== Example - Multi line ==== 
 +<code javascript> 
 +function OnStart() 
 +{ 
 +  lay = app.CreateLayout( "Linear", "VCenter,FillXY" ); 
 + 
 +  txt = app.CreateText( "Hello\nWorld", 0.8, 0.2, "Multiline" ); 
 +  txt.SetTextSize( 12 ); 
 +  txt.SetTextColor( "#ff6666ff" ); 
 +  txt.SetBackColor( "#ffffffff" ); 
 +  lay.AddChild( txt ); 
 + 
 +  app.AddLayout( lay ); 
 +} 
 +</code> 
 +You can also set a background image/pattern or background gradient for the Text using the **SetBackground** and **SetBackGradient** functions. See **[[built_in:layouts|Layouts]]** for examples of how to use these functions. 
 ===== Methods ===== ===== Methods =====
 Some controls use the same methods.\\ Some controls use the same methods.\\
 For examples of the **[[same methods]]** look here. For examples of the **[[same methods]]** look here.
-^Method ^Description ^ +^ Method                                                       ^ Description                                                                           ^ 
-|Text.Destroy() | | +| Text.Destroy()                                               |                                                                                       | 
-|Text.GetAbsHeight() | | +| Text.GetAbsHeight()                                          |                                                                                       | 
-|Text.GetAbsWidth() | | +| Text.GetAbsWidth()                                           |                                                                                       | 
-|Text.GetHeight() | | +| Text.GetHeight()                                             |                                                                                       | 
-|Text.GetLineCount() | | +| Text.GetLineCount()                                          |                                                                                       | 
-|Text.GetLineStart( line ) | | +| Text.GetLineStart( line )                                    |                                                                                       | 
-|Text.GetLineTop( line ) | | +| Text.GetLineTop( line )                                      |                                                                                       | 
-|Text.GetMaxLines() | | +| Text.GetMaxLines()                                           |                                                                                       | 
-|Text.GetPosition() | | +| Text.GetPosition()                                           |                                                                                       | 
-|Text.GetText() | | +| Text.GetText()                                               |                                                                                       | 
-|Text.GetTextSize( mode ) | | +| Text.GetTextSize( mode )                                     |                                                                                       | 
-|Text.GetType() | | +| [[built_in:gettype|Text.GetType()]]                          | Returns "Text"                                                                        | 
-|Text.GetVisibility() | | +| Text.GetVisibility()                                         |                                                                                       | 
-|Text.GetWidth() | | +| Text.GetWidth()                                              |                                                                                       | 
-|Text.Release() | | +| Text.Release()                                               |                                                                                       | 
-|Text.SetBackColor( color ) | | +| Text.SetBackColor( color )                                   |                                                                                       | 
-|Text.SetBackGradient( color1,color2,color3,p4,p5,p6,p7 ) | | +| Text.SetBackGradient( color1,color2,color3,p4,p5,p6,p7 )     |                                                                                       | 
-|Text.SetBackGradientRadial( x,y,r,color1,color2,color3,p7 ) | | +| Text.SetBackGradientRadial( x,y,r,color1,color2,color3,p7 )  |                                                                                       | 
-|Text.SetBackground( imagefile,options ) | | +| Text.SetBackground( imagefile,options )                      |                                                                                       | 
-|Text.SetEllipsize( mode ) | | +| Text.SetEllipsize( mode )                                    | Shorten long text with "..."  mode="**Start**","**Middle**", "**End**" or "**marq**"  | 
-|Text.SetFontFile( file ) | | +| Text.SetFontFile( file )                                     |                                                                                       | 
-|Text.SetHtml( html ) | | +| Text.SetHtml( html )                                         |                                                                                       | 
-|Text.SetMargins( left,top,right,bottom ) | | +| Text.SetMargins( left,top,right,bottom )                     |                                                                                       | 
-|Text.SetOnLongTouch( callback ) | | +| Text.SetOnLongTouch( callback )                              |                                                                                       | 
-|Text.SetOnTouch( callback ) | | +| Text.SetOnTouch( callback )                                  |                                                                                       | 
-|Text.SetOnTouchDown( callback ) | | +| Text.SetOnTouchDown( callback )                              |                                                                                       | 
-|Text.SetOnTouchMove( callback ) | | +| Text.SetOnTouchMove( callback )                              |                                                                                       | 
-|Text.SetOnTouchUp( callback ) | | +| Text.SetOnTouchUp( callback )                                |                                                                                       | 
-|Text.SetPadding( left,top,right,bottom ) | | +| Text.SetPadding( left,top,right,bottom )                     |                                                                                       | 
-|Text.SetPosition( left,top,width,height ) | | +| Text.SetPosition( left,top,width,height )                    |                                                                                       | 
-|Text.SetScale( x,y ) | | +| Text.SetScale( x,y )                                         |                                                                                       | 
-|Text.SetSize( width,height ) | | +| Text.SetSize( width,height )                                 |                                                                                       | 
-|Text.SetText( text ) | | +| Text.SetText( text )                                         |                                                                                       | 
-|Text.SetTextColor( color ) | | +| Text.SetTextColor( color )                                   |                                                                                       | 
-|Text.SetTextShadow( radius,dx,dy,color ) | | +| Text.SetTextShadow( radius,dx,dy,color )                     |                                                                                       | 
-|Text.SetTextSize( size,mode ) | | +| Text.SetTextSize( size,mode )                                |                                                                                       | 
-|Text.SetTouchable( touchable ) | | +| Text.SetTouchable( touchable )                               |                                                                                       | 
-|Text.SetVisibility( HideShow ) | |+| Text.SetVisibility( HideShow )                               |                                                                                       |
  
 ===== Options ===== ===== Options =====
  
-^Option ^Description ^ +^ Option       ^ Description                                          ^ 
-|FontAwesome|Use this to display Icons \\ from this inbuilt font| +| AutoScale    | reduces text size to fit if needed                   | 
-|Html| | +| Bold         | Write bold Text                                      | 
-|Left| | +| FontAwesome  | Use this to display Icons \\ from this inbuilt font  | 
-|Multiline| | +| Html         |                                                      | 
-|Right| |+| Left         |                                                      | 
 +| Multiline    |                                                      | 
 +| Right        |                                                      | 
 +| NoWrap       |                                                      | 
 +| Log          | Log=='multiline,left,nowrap'                         | 
  
built_in/text.txt · Last modified: 2019/06/22 01:01 (external edit)

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki