gui.setClipboardContent

Stores some content in the clipboard.

Prototype

  1. bOk = gui.setClipboardContent ( vValue )

Description

Useful in all sorts of "Copy/Paste" functions.

Parameters

vValue - the variable value you want to store

Return values

bOk - true on success

Sample

  1. function onLogCopy (  )
  2.  
  3.     local hTabCategory = gui.getComponent ( "CategoryTab" )
  4.  
  5.     if  ( hTabCategory ) then            
  6.         local hTree = gui.getComponentFromInstance ( gui.getTabItemComponent ( gui.getTabContainerCurrentItem ( hTabCategory )) , "content" )
  7.  
  8.         if  ( hTree ) then                
  9.             local sSelectedText = ""
  10.  
  11.             for i = 1, gui.getTreeSelectedItemCount ( hTree ) do
  12.                 sSelectedText = sSelectedText .. gui.getTreeItemText ( gui.getTreeItemColumnSiblingItem ( gui.getTreeSelectedItem ( hTree, i ), 2 ) ) .."n"
  13.             end
  14.  
  15.             if ( not string.isEmpty ( sSelectedText ) ) then
  16.                 gui.setClipboardContent ( sSelectedText )
  17.             end
  18.  
  19.         end
  20.     end
  21. end

Available since ShiVa 2.0