Class: Tk::Winico

Inherits:
TkObject show all
Defined in:
ext/lib/tkextlib/winico/winico.rb,
ext/lib/tkextlib/winico/winico.rb

Defined Under Namespace

Classes: Winico_callback

Constant Summary collapse

PACKAGE_NAME = 
'winico'.freeze
WinicoID_TBL = 
TkCore::INTERP.create_table

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

Constants included from Tk

AUTO_PATH, Checkbutton, CloneMenu, JAPANIZED_TK, LIBRARY_PATH, Labelframe, MenuButton, OptionMenuButton, PACKAGE_PATH, Panedwindow, RELEASE_DATE, Radiobutton, TCL_LIBRARY_PATH, TCL_MAJOR_VERSION, TCL_MINOR_VERSION, TCL_PACKAGE_PATH, TCL_PATCHLEVEL, TCL_PRECISION, TCL_VERSION, TK_MAJOR_VERSION, TK_MINOR_VERSION, TK_PATCHLEVEL, TK_VERSION, Tkextlib_RELEASE_DATE, TreeCtrl_Widget, X_Scrollable, Y_Scrollable

Constants included from Encoding

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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from TkObject

#epath, #event_generate, #method_missing, #path, #tk_send, #tk_send_to_list, #tk_send_to_list_with_enc, #tk_send_to_list_without_enc, #tk_send_to_simplelist, #tk_send_to_simplelist_with_enc, #tk_send_to_simplelist_without_enc, #tk_send_with_enc, #tk_send_without_enc, #to_eval

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, #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_str, number, procedure, simplelist, string, #subst, tk_tcl2ruby, uninstall_cmd, #uninstall_cmd, window

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_str, #num_or_str, number, #number, string, #string, uninstall_cmd

Methods included from TkEvent

#install_bind, #install_bind_for_event_class

Methods included from TkBindCore

#bind, #bind_append, #bind_remove, #bindinfo

Methods included from TkConfigMethod

#[], #[]=, __IGNORE_UNKNOWN_CONFIGURE_OPTION__, #__check_available_configure_options, __set_IGNORE_UNKNOWN_CONFIGURE_OPTION__!, #cget, #cget_strict, #config_hash_kv, #configinfo, #configure, #configure_cmd, #current_configinfo

Methods included from TkTreatFont

#font_configinfo, #font_configure, #font_copy, #kanjifont_configure, #kanjifont_copy, #latinfont_configure, #latinfont_copy

Methods included from Tk

BinaryString, EncodedString, #Grid, #Pack, #Place, UTF8_String, __set_toplevel_aliases__, add_kinsoku, bell, bell_on_display, const_missing, current_grabs, cursor_display, default_widget_set, default_widget_set=, delete_kinsoku, destroy, 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, #root, 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, ungrid, unload_tcllibrary, unpack, unplace, #update, update, update_idletasks, utf_to_backslash, utf_to_backslash_sequence, wakeup

Methods included from 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 inherited from TkKernel

new

Constructor Details

#initialize(file_name, resource_name = nil, winico_id = nil) ⇒ Winico

Returns a new instance of Winico.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'ext/lib/tkextlib/winico/winico.rb', line 71

def initialize(file_name, resource_name=nil, winico_id=nil)
  if resource_name
    # from resource
    if file_name
      @id = Tk.tk_call('winico', 'load', resource_name, file_name)
    else
      @id = Tk.tk_call('winico', 'load', resource_name)
    end
  elsif file_name
    # from .ico file
    @id = Tk.tk_call('winico', 'createfrom', file_name)
  elsif winico_id
    @id = winico_id
  else
    fail ArgumentError, 
         "must be given proper information from where loading icons"
  end
  @path = @id
  WinicoID_TBL.mutex.synchronize{
    WinicoID_TBL[@id] = self
  }
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class TkObject

Class Method Details

.icon_info(id) ⇒ Object 



54
55
56
57
58
59
 
# File 'ext/lib/tkextlib/winico/winico.rb', line 54

def self.icon_info(id)
  simplelist(Tk.tk_call('winico', 'info', id)).collect{|inf|
    h = Hash[*list(inf)]
    h.keys.each{|k| h[k[1..-1]] = h.delete(k)}
  }
end

.id2obj(id) ⇒ Object 



42
43
44
45
46
 
# File 'ext/lib/tkextlib/winico/winico.rb', line 42

def self.id2obj(id)
  WinicoID_TBL.mutex.synchronize{
    (WinicoID_TBL.key?(id))? WinicoID_TBL[id] : id
  }
end

.info ⇒ Object 



48
49
50
51
52
 
# File 'ext/lib/tkextlib/winico/winico.rb', line 48

def self.info
  simplelist(Tk.tk_call('winico', 'info')).collect{|id| 
    Tk::Winico.id2obj(id)
  }
end

.new_from_file(file_name) ⇒ Object 



63
64
65
 
# File 'ext/lib/tkextlib/winico/winico.rb', line 63

def self.new_from_file(file_name)
  self.new(file_name)
end

.new_from_resource(resource_name, file_name = nil) ⇒ Object 



67
68
69
 
# File 'ext/lib/tkextlib/winico/winico.rb', line 67

def self.new_from_resource(resource_name, file_name = nil)
  self.new(file_name, resource_name)
end

.package_name ⇒ Object 



21
22
23
 
# File 'ext/lib/tkextlib/winico/winico.rb', line 21

def self.package_name
  PACKAGE_NAME
end

.package_version ⇒ Object 



25
26
27
28
29
30
31
 
# File 'ext/lib/tkextlib/winico/winico.rb', line 25

def self.package_version
  begin
    TkPackage.require('winico')
  rescue
    ''
  end
end

Instance Method Details

#add_to_taskbar(keys = {}) ⇒ Object Also known as: taskbar_add 



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'ext/lib/tkextlib/winico/winico.rb', line 185

def add_to_taskbar(keys = {})
  keys = _symbolkey2str(keys)
  Winico_callback._config_keys.each{|k|
    if keys[k].kind_of?(Array)
      cmd, *args = keys[k]
      #keys[k] = Winico_callback.new(cmd, args.join(' '))
      keys[k] = Winico_callback.new(cmd, *args)
     # elsif keys[k].kind_of?(Proc)
    elsif TkComm._callback_entry?(keys[k])
      keys[k] = Winico_callback.new(keys[k])
    end
  }
  tk_call('winico', 'taskbar', 'add', @id, *(hash_kv(keys)))
  self
end

#delete ⇒ Object Also known as: destroy 



104
105
106
107
108
109
110
 
# File 'ext/lib/tkextlib/winico/winico.rb', line 104

def delete
  tk_call('winico', 'delete', @id)
  WinicoID_TBL.mutex.synchronize{
    WinicoID_TBL.delete(@id)
  }
  self
end

#delete_from_taskbar ⇒ Object Also known as: taskbar_delete 



219
220
221
222
 
# File 'ext/lib/tkextlib/winico/winico.rb', line 219

def delete_from_taskbar
  tk_call('winico', 'taskbar', 'delete', @id)
  self
end

#id ⇒ Object 



94
95
96
 
# File 'ext/lib/tkextlib/winico/winico.rb', line 94

def id
  @id
end

#info ⇒ Object 



113
114
115
 
# File 'ext/lib/tkextlib/winico/winico.rb', line 113

def info
  Tk::Winico.icon_info(@id)
end

#modify_taskbar(keys = {}) ⇒ Object Also known as: taskbar_modify 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'ext/lib/tkextlib/winico/winico.rb', line 202

def modify_taskbar(keys = {})
  keys = _symbolkey2str(keys)
  Winico_callback._config_keys.each{|k|
    if keys[k].kind_of?(Array)
      cmd, *args = keys[k]
      #keys[k] = Winico_callback.new(cmd, args.join(' '))
      keys[k] = Winico_callback.new(cmd, *args)
    # elsif keys[k].kind_of?(Proc)
    elsif TkComm._callback_entry?(keys[k])
      keys[k] = Winico_callback.new(keys[k])
    end
  }
  tk_call('winico', 'taskbar', 'modify', @id, *(hash_kv(keys)))
  self
end

#set_window(win_id, *opts) ⇒ Object

opts := ?‘big’|‘small’?, ?pos?



98
99
100
101
102
 
# File 'ext/lib/tkextlib/winico/winico.rb', line 98

def set_window(win_id, *opts) # opts := ?'big'|'small'?, ?pos?
  # NOTE:: the window, which is denoted by win_id, MUST BE MAPPED. 
  #        If not, then this may fail or crash.
  tk_call('winico', 'setwindow', win_id, @id, *opts)
end