Module: TkClipboard

Extended by:
Tk
Includes:
Tk
Defined in:
lib/tk/clipboard.rb

Constant Summary collapse

TkCommandNames = 
['clipboard'.freeze].freeze

Constants included from Tk

Tk::AUTO_PATH, Tk::Fontchooser, Tk::INTERP, Tk::JAPANIZED_TK, Tk::LIBRARY_PATH, Tk::MAINLOOP, Tk::PACKAGE_PATH, Tk::RELEASE_DATE, Tk::TCL_LIBRARY_PATH, Tk::TCL_MAJOR_VERSION, Tk::TCL_MINOR_VERSION, Tk::TCL_PACKAGE_PATH, Tk::TCL_PATCHLEVEL, Tk::TCL_PRECISION, Tk::TCL_VERSION, Tk::TK_MAJOR_VERSION, Tk::TK_MINOR_VERSION, Tk::TK_PATCHLEVEL, Tk::TK_VERSION, Tk::Tkextlib_RELEASE_DATE, Tk::TreeCtrl_Widget, Tk::X_Scrollable, Tk::Y_Scrollable

Constants included from Tk::Encoding

Tk::Encoding::BINARY, Tk::Encoding::BINARY_NAME, Tk::Encoding::DEFAULT_EXTERNAL_NAME, Tk::Encoding::DEFAULT_INTERNAL_NAME, Tk::Encoding::ENCODING_TABLE, Tk::Encoding::RubyEncoding, Tk::Encoding::UNKNOWN, Tk::Encoding::UTF8_NAME

Constants included from TkCore

TkCore::EventFlag, TkCore::INTERP, TkCore::INTERP_MUTEX, TkCore::INTERP_ROOT_CHECK, TkCore::INTERP_THREAD, TkCore::INTERP_THREAD_STATUS, TkCore::RUN_EVENTLOOP_ON_MAIN_THREAD, TkCore::WIDGET_DESTROY_HOOK, TkCore::WITH_ENCODING, TkCore::WITH_RUBY_VM

Constants included from TkComm

TkComm::GET_CONFIGINFO_AS_ARRAY, TkComm::GET_CONFIGINFOwoRES_AS_ARRAY, TkComm::TkExtlibAutoloadModule, TkComm::Tk_CMDTBL, TkComm::Tk_IDs, TkComm::Tk_WINDOWS, TkComm::USE_TCLs_LIST_FUNCTIONS, TkComm::WidgetClassNames

Constants included from TkUtil

TkUtil::None, TkUtil::RELEASE_DATE

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Tk

BinaryString, EncodedString, Grid, Pack, Place, UTF8_String, __create_widget_set__, __disable_toplevel_control__, __import_toplevel_aliases__, __regist_toplevel_aliases__, __remove_toplevel_aliases__, __reset_toplevel_owner__, __set_loaded_toplevel_aliases__, __set_toplevel_aliases__, __toplevel_alias_setup_proc__, _replace_toplevel_aliases, add_kinsoku, backup_current_topdef, bell, bell_on_display, const_missing, current_grabs, cursor_display, default_widget_set, default_widget_set=, define_topalias, define_topobj, delete_kinsoku, destroy, encoding, encoding=, errorCode, errorInfo, exit, focus, focus_lastfor, focus_next, focus_prev, focus_to, fromUTF8, grid, grid_forget, has_mainwindow?, load_tcllibrary, load_tclscript, load_tclscript_rsrc, load_tclscript_rsrcid, lower_window, pack, pack_forget, pkgconfig_get, pkgconfig_list, place, place_forget, raise_window, regist_sym_for_loaded_file, replace_topalias, replace_topobj, root, set_topalias, show_kinsoku, sleep, strictMotif, subst_tk_backslash, subst_utf_backslash, tcl_pkgconfig_get, tcl_pkgconfig_list, thread_update, thread_update_idletasks, tk_pkgconfig_get, tk_pkgconfig_list, toUTF8, to_backslash_sequence, topalias_defined?, toplevel_aliases_on_widget_set, topobj_defined?, ungrid, unload_tcllibrary, unpack, unplace, update, update, update_idletasks, utf_to_backslash, utf_to_backslash_sequence, wakeup, widget_set_symbols

Methods included from Tk::Encoding

#default_encoding=, #encoding=, #encoding_convertfrom, #encoding_convertto, #encoding_dirs, #encoding_dirs=, #encoding_name, #encoding_names, #encoding_obj, #encoding_objs, #encoding_system=, #encoding_system_name, #encoding_system_obj, #force_default_encoding, #force_default_encoding=, #force_default_encoding?, #tk_encoding_names

Methods included from TkCore

#_tk_call_to_list_core, #after, #after_cancel, #after_idle, #appname, #appsend, #appsend_deny, #appsend_displayof, callback, #callback_break, #callback_continue, #callback_return, #chooseColor, #chooseDirectory, #do_one_event, #event_generate, #getMultipleOpenFile, #getMultipleSaveFile, #getOpenFile, #getSaveFile, #get_eventloop_tick, #get_eventloop_weight, #get_no_event_wait, #inactive, #inactive_displayof, #info, #ip_eval, #ip_eval_with_enc, #ip_eval_without_enc, #ip_invoke, #ip_invoke_with_enc, #ip_invoke_without_enc, #is_mainloop?, #load_cmd_on_ip, #mainloop, #mainloop_exist?, #mainloop_thread?, #mainloop_watchdog, #messageBox, #rb_appsend, #rb_appsend_displayof, #reset_inactive, #reset_inactive_displayof, #restart, #scaling, #scaling_displayof, #set_eventloop_tick, #set_eventloop_weight, #set_no_event_wait, #tk_call, #tk_call_to_list, #tk_call_to_list_with_enc, #tk_call_to_list_without_enc, #tk_call_to_simplelist, #tk_call_to_simplelist_with_enc, #tk_call_to_simplelist_without_enc, #tk_call_with_enc, #tk_call_without_enc, #windowingsystem

Methods included from TkComm

_at, _callback_entry?, _callback_entry_class?, _curr_cmd_id, _fromUTF8, _genobj_for_tkwidget, _next_cmd_id, _toUTF8, array2tk_list, #bind, #bind_all, #bind_append, #bind_append_all, #bind_remove, #bind_remove_all, #bindinfo, #bindinfo_all, bool, image_obj, #install_cmd, install_cmd, list, num_or_nil, num_or_str, number, procedure, simplelist, slice_ary, string, #subst, tk_tcl2ruby, uninstall_cmd, #uninstall_cmd, window

Methods included from TkEvent

#install_bind, #install_bind_for_event_class

Methods included from TkUtil

#_conv_args, _conv_args, #_fromUTF8, #_get_eval_enc_str, _get_eval_enc_str, #_get_eval_string, _get_eval_string, _symbolkey2str, #_symbolkey2str, #_toUTF8, #bool, bool, callback, eval_cmd, #hash_kv, hash_kv, install_cmd, #num_or_nil, num_or_nil, num_or_str, #num_or_str, number, #number, string, #string, uninstall_cmd, untrust

Class Method Details

.append(data, keys = nil) ⇒ Object 



47
48
49
50
51
52
 
# File 'lib/tk/clipboard.rb', line 47

def self.append(data, keys=nil)
  args = ['clipboard', 'append']
  args.concat(hash_kv(keys))
  args.concat(['--', data])
  tk_call(*args)
end

.append_on_display(win, data, keys = nil) ⇒ Object 



53
54
55
56
57
58
 
# File 'lib/tk/clipboard.rb', line 53

def self.append_on_display(win, data, keys=nil)
  args = ['clipboard', 'append', '-displayof', win]
  args.concat(hash_kv(keys))
  args.concat(['--', data])
  tk_call(*args)
end

.clear(win = nil) ⇒ Object 



12
13
14
15
16
17
18
 
# File 'lib/tk/clipboard.rb', line 12

def self.clear(win=nil)
  if win
    tk_call_without_enc('clipboard', 'clear', '-displayof', win)
  else
    tk_call_without_enc('clipboard', 'clear')
  end
end

.clear_on_display(win) ⇒ Object 



19
20
21
 
# File 'lib/tk/clipboard.rb', line 19

def self.clear_on_display(win)
  tk_call_without_enc('clipboard', 'clear', '-displayof', win)
end

.get(type = nil) ⇒ Object 



23
24
25
26
27
28
29
 
# File 'lib/tk/clipboard.rb', line 23

def self.get(type=nil)
  if type
    tk_call_without_enc('clipboard', 'get', '-type', type)
  else
    tk_call_without_enc('clipboard', 'get')
  end
end

.get_on_display(win, type = nil) ⇒ Object 



30
31
32
33
34
35
36
 
# File 'lib/tk/clipboard.rb', line 30

def self.get_on_display(win, type=nil)
  if type
    tk_call_without_enc('clipboard', 'get', '-displayof', win, '-type', type)
  else
    tk_call_without_enc('clipboard', 'get', '-displayof', win)
  end
end

.set(data, keys = nil) ⇒ Object 



38
39
40
41
 
# File 'lib/tk/clipboard.rb', line 38

def self.set(data, keys=nil)
  clear
  append(data, keys)
end

.set_on_display(win, data, keys = nil) ⇒ Object 



42
43
44
45
 
# File 'lib/tk/clipboard.rb', line 42

def self.set_on_display(win, data, keys=nil)
  clear(win)
  append_on_display(win, data, keys)
end

Instance Method Details

#append(data, keys = nil) ⇒ Object 



71
72
73
74
 
# File 'lib/tk/clipboard.rb', line 71

def append(data, keys=nil)
  TkClipboard.append_on_display(self, data, keys)
  self
end

#clear ⇒ Object 



60
61
62
63
 
# File 'lib/tk/clipboard.rb', line 60

def clear
  TkClipboard.clear_on_display(self)
  self
end

#get(type = nil) ⇒ Object 



64
65
66
 
# File 'lib/tk/clipboard.rb', line 64

def get(type=nil)
  TkClipboard.get_on_display(self, type)
end

#set(data, keys = nil) ⇒ Object 



67
68
69
70
 
# File 'lib/tk/clipboard.rb', line 67

def set(data, keys=nil)
  TkClipboard.set_on_display(self, data, keys)
  self
end