Class: TkcTag

Inherits:
TkObject show all
Includes:
TkcTagAccess
Defined in:
lib/tk/canvastag.rb

Direct Known Subclasses

TkcGroup, TkcTagString

Constant Summary collapse

CTagID_TBL =
TkCore::INTERP.create_table

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 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 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::TkCommandNames, Tk::Encoding::UNKNOWN, Tk::Encoding::UTF8_NAME

Class Method Summary collapse

Instance Method Summary collapse

Methods included from TkcTagAccess

#&, #[email protected], #^, #addtag, #bbox, #bind, #bind_append, #bind_remove, #bindinfo, #cget, #cget_strict, #cget_tkstring, #configinfo, #configure, #coords, #current_configinfo, #dchars, #dtag, #find, #focus, #gettags, #icursor, #imove, #index, #insert, #itemtype, #lower, #move, #moveto, #raise, #rchars, #scale, #select_adjust, #select_from, #select_to, #|

Methods included from TkTreatTagFont

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

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

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

new

Constructor Details

#initialize(parent, mode = nil, *args) ⇒ TkcTag

Returns a new instance of TkcTag.


253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
# File 'lib/tk/canvastag.rb', line 253

def initialize(parent, mode=nil, *args)
  #unless parent.kind_of?(TkCanvas)
  #  fail ArgumentError, "expect TkCanvas for 1st argument"
  #end
  @c = parent
  @cpath = parent.path
  Tk_CanvasTag_ID.mutex.synchronize{
    # @path = @id = Tk_CanvasTag_ID.join('')
    @path = @id = Tk_CanvasTag_ID.join(TkCore::INTERP._ip_id_)
    Tk_CanvasTag_ID[1].succ!
  }
  CTagID_TBL.mutex.synchronize{
    CTagID_TBL[@cpath] = {} unless CTagID_TBL[@cpath]
    CTagID_TBL[@cpath][@id] = self
  }
  if mode
    tk_call_without_enc(@c.path, "addtag", @id, mode, *args)
  end
end

Dynamic Method Handling

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

Class Method Details

.id2obj(canvas, id) ⇒ Object


242
243
244
245
246
247
248
249
250
251
# File 'lib/tk/canvastag.rb', line 242

def TkcTag.id2obj(canvas, id)
  cpath = canvas.path
  CTagID_TBL.mutex.synchronize{
    if CTagID_TBL[cpath]
      CTagID_TBL[cpath][id]? CTagID_TBL[cpath][id]: id
    else
      id
    end
  }
end

Instance Method Details

#deleteObject Also known as: remove, destroy


284
285
286
287
288
289
290
# File 'lib/tk/canvastag.rb', line 284

def delete
  @c.delete @id
  CTagID_TBL.mutex.synchronize{
    CTagID_TBL[@cpath].delete(@id) if CTagID_TBL[@cpath]
  }
  self
end

#exist?Boolean

Returns:

  • (Boolean)

276
277
278
279
280
281
282
# File 'lib/tk/canvastag.rb', line 276

def exist?
  if @c.find_withtag(@id)
    true
  else
    false
  end
end

#idObject


272
273
274
# File 'lib/tk/canvastag.rb', line 272

def id
  @id
end

#set_to_above(target) ⇒ Object Also known as: above


294
295
296
297
# File 'lib/tk/canvastag.rb', line 294

def set_to_above(target)
  @c.addtag_above(@id, target)
  self
end

#set_to_allObject Also known as: all


300
301
302
303
# File 'lib/tk/canvastag.rb', line 300

def set_to_all
  @c.addtag_all(@id)
  self
end

#set_to_below(target) ⇒ Object Also known as: below


306
307
308
309
# File 'lib/tk/canvastag.rb', line 306

def set_to_below(target)
  @c.addtag_below(@id, target)
  self
end

#set_to_closest(x, y, halo = None, start = None) ⇒ Object Also known as: closest


312
313
314
315
# File 'lib/tk/canvastag.rb', line 312

def set_to_closest(x, y, halo=None, start=None)
  @c.addtag_closest(@id, x, y, halo, start)
  self
end

#set_to_enclosed(x1, y1, x2, y2) ⇒ Object Also known as: enclosed


318
319
320
321
# File 'lib/tk/canvastag.rb', line 318

def set_to_enclosed(x1, y1, x2, y2)
  @c.addtag_enclosed(@id, x1, y1, x2, y2)
  self
end

#set_to_overlapping(x1, y1, x2, y2) ⇒ Object Also known as: overlapping


324
325
326
327
# File 'lib/tk/canvastag.rb', line 324

def set_to_overlapping(x1, y1, x2, y2)
  @c.addtag_overlapping(@id, x1, y1, x2, y2)
  self
end

#set_to_withtag(target) ⇒ Object Also known as: withtag


330
331
332
333
# File 'lib/tk/canvastag.rb', line 330

def set_to_withtag(target)
  @c.addtag_withtag(@id, target)
  self
end