Class: Tk::Tcllib::ICO

Inherits:
TkImage show all
Defined in:
lib/tkextlib/tcllib/ico.rb,
lib/tkextlib/tcllib/ico.rb

Constant Summary collapse

PACKAGE_NAME =
'ico'.freeze

Constants inherited from TkImage

TkImage::TkCommandNames, TkImage::Tk_IMGTBL

Constants included from Tk

AUTO_PATH, Fontchooser, INTERP, JAPANIZED_TK, LIBRARY_PATH, MAINLOOP, PACKAGE_PATH, 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, 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

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 inherited from TkImage

#delete, #height, #inuse, #itemtype, names, new, types, #width

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 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, 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

Methods inherited from TkObject

#destroy, #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 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, #cget_tkstring, #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 inherited from TkKernel

new

Constructor Details

#initialize(file, index, keys = nil) ⇒ ICO

Returns a new instance of ICO.


122
123
124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/tkextlib/tcllib/ico.rb', line 122

def initialize(file, index, keys=nil)
  keys = _symbolkey2str(keys)
  if keys.key?('name')
    @path = keys['name'].to_s
  else
    Tk_Image_ID.mutex.synchronize{
      @path = Tk_Image_ID.join(TkCore::INTERP._ip_id_)
      Tk_Image_ID[1].succ!
    }
  end
  tk_call_without_enc('::ico::getIcon', file, index, '-name', @path,
                      '-format', 'image', *hash_kv(keys, true))
  Tk_IMGTBL[@path] = self
end

Dynamic Method Handling

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

Class Method Details

.clear_cache(file = None) ⇒ Object


103
104
105
# File 'lib/tkextlib/tcllib/ico.rb', line 103

def self.clear_cache(file=None)
  tk_call_without_enc('::ico::clearCache', file)
end

.copy(from_file, from_index, to_file, to_index, keys = nil) ⇒ Object


92
93
94
95
96
# File 'lib/tkextlib/tcllib/ico.rb', line 92

def self.copy(from_file, from_index, to_file, to_index, keys=nil)
  tk_call_without_enc('::ico::copyIcon',
                      from_file, from_index, to_file, to_index,
                      *hash_kv(keys, true))
end

.exe_to_ico(exe_file, ico_file, keys = nil) ⇒ Object


98
99
100
101
# File 'lib/tkextlib/tcllib/ico.rb', line 98

def self.exe_to_ico(exe_file, ico_file, keys=nil)
  tk_call_without_enc('::ico::copyIcon', exe_file, ico_file,
                      *hash_kv(keys, true))
end

.get(file, index, keys = nil) ⇒ Object


56
57
58
# File 'lib/tkextlib/tcllib/ico.rb', line 56

def self.get(file, index, keys=nil)
  tk_call_without_enc('::ico::getIcon', file, index, *hash_kv(keys, true))
end

.get_by_name(file, name, keys = nil) ⇒ Object


63
64
65
66
# File 'lib/tkextlib/tcllib/ico.rb', line 63

def self.get_by_name(file, name, keys=nil)
  tk_call_without_enc('::ico::getIconByName', file, name,
                      *hash_kv(keys, true))
end

.get_data(file, index, keys = {}) ⇒ Object


81
82
83
84
85
# File 'lib/tkextlib/tcllib/ico.rb', line 81

def self.get_data(file, index, keys={})
  keys['format'] = 'data'
  tk_split_list(tk_call_without_enc('::ico::getIcon', file, index,
                                    *hash_kv(keys, true)))
end

.get_fileicon(file, keys = nil) ⇒ Object


71
72
73
# File 'lib/tkextlib/tcllib/ico.rb', line 71

def self.get_fileicon(file, keys=nil)
  tk_call_without_enc('::ico::getFileIcon', file, *hash_kv(keys, true))
end

.get_icon(*args) ⇒ Object


59
60
61
# File 'lib/tkextlib/tcllib/ico.rb', line 59

def self.get_icon(*args)
  get(*args)
end

.get_icon_by_name(*args) ⇒ Object


67
68
69
# File 'lib/tkextlib/tcllib/ico.rb', line 67

def self.get_icon_by_name(*args)
  get_by_name(*args)
end

.get_image(file, index, keys = {}) ⇒ Object


75
76
77
78
79
# File 'lib/tkextlib/tcllib/ico.rb', line 75

def self.get_image(file, index, keys={})
  keys = _symbolkey2str(keys)
  keys.delete('format')
  self.new(file, index, keys)
end

.get_members(file, name, keys = nil) ⇒ Object


48
49
50
51
52
53
54
# File 'lib/tkextlib/tcllib/ico.rb', line 48

def self.get_members(file, name, keys=nil)
  tk_split_simplelist(tk_call_without_enc('::ico::getMembers', file, name,
                                          *hash_kv(keys, true))).map{|elem|
    name, width, height, bpp =  tk_split_simplelist(elem)
    [name, number(width), number(height), number(bpp)]
  }
end

.icons(file, keys = nil) ⇒ Object


41
42
43
44
45
46
# File 'lib/tkextlib/tcllib/ico.rb', line 41

def self.icons(file, keys=nil)
  tk_split_simplelist(tk_call_without_enc('::ico::icons', file,
                                          *hash_kv(keys, true))).map{|elem|
    num_or_str(elem)
  }
end

.list(file, keys = nil) ⇒ Object


36
37
38
39
# File 'lib/tkextlib/tcllib/ico.rb', line 36

def self.list(file, keys=nil)
  tk_split_list(tk_call_without_enc('::ico::getIconList', file,
                                    *hash_kv(keys, true)))
end

.package_nameObject


20
21
22
# File 'lib/tkextlib/tcllib/ico.rb', line 20

def self.package_name
  PACKAGE_NAME
end

.package_versionObject


24
25
26
27
28
29
30
# File 'lib/tkextlib/tcllib/ico.rb', line 24

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

.show(file, keys = nil) ⇒ Object


116
117
118
# File 'lib/tkextlib/tcllib/ico.rb', line 116

def self.show(file, keys=nil)
  tk_call_without_enc('::ico::Show', file, *hash_kv(keys, true))
end

.transparent_color(image, color) ⇒ Object


107
108
109
110
111
112
113
114
# File 'lib/tkextlib/tcllib/ico.rb', line 107

def self.transparent_color(image, color)
  if image.kind_of?(Array)
    tk_split_list(tk_call_without_enc('::ico::transparentColor',
                                      image, color))
  else
    tk_call_without_enc('::ico::transparentColor', image, color)
  end
end

.write(file, index, depth, data, keys = nil) ⇒ Object


87
88
89
90
# File 'lib/tkextlib/tcllib/ico.rb', line 87

def self.write(file, index, depth, data, keys=nil)
  tk_call_without_enc('::ico::writeIcon', file, index, depth, data,
                      *hash_kv(keys, true))
end

Instance Method Details

#transparent_color(color) ⇒ Object


142
143
144
145
# File 'lib/tkextlib/tcllib/ico.rb', line 142

def transparent_color(color)
  tk_call_without_enc('::ico::transparentColor', @path, color)
  self
end

#write(file, index, depth, keys = nil) ⇒ Object


137
138
139
140
# File 'lib/tkextlib/tcllib/ico.rb', line 137

def write(file, index, depth, keys=nil)
  Tk::Tcllib::ICO.write(file, index, depth, @path, keys=nil)
  self
end