Class: TkTextFrame

Inherits:
TkText show all
Includes:
TkComposite
Defined in:
sample/tktextframe.rb

Constant Summary

Constants included from Tk

Tk::AUTO_PATH, 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::TkCommandNames

Constants included from TkCore

TkCore::EventFlag, TkCore::INTERP, TkCore::WIDGET_DESTROY_HOOK

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

TkText::ItemConfCMD, TkText::TkCommandNames, TkText::WidgetClassName

Constants inherited from TkTextWin

TkTextWin::TkCommandNames

Constants inherited from TkWindow

TkWindow::TkCommandNames, TkWindow::WidgetClassName

Constants included from TkWinfo

TkWinfo::TkCommandNames

Constants included from Tk::TkDND::Shape

Tk::TkDND::Shape::PACKAGE_NAME

Instance Method Summary collapse

Methods included from TkComposite

#cget, #configinfo, #configure, #database_class, #database_classname, #delegate, #delegate_alias, #epath, #initialize, #option_methods

Methods included from Tk

BinaryString, EncodedString, UTF8_String, add_kinsoku, bell, bell_on_display, const_missing, current_grabs, cursor_display, 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, #root, show_kinsoku, 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

Methods included from Tk::Encoding

#encoding, #encoding=, #encoding_convertfrom, #encoding_convertto, #encoding_dirs, #encoding_dirs=, #encoding_names, #encoding_system, #encoding_system=

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, #bind, #bind_all, #bind_append, #bind_append_all, #bind_remove, #bind_remove_all, #bindinfo, #bindinfo_all, #image_obj, #install_cmd, #subst, #uninstall_cmd

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

Methods inherited from TkText

#__destroy_hook__, #_addcmd, #_addtag, at, #at, #backspace, #bbox, #clear, #compare, #count, #count_info, #current_image_configinfo, #debug, #debug=, #destroy, #dlineinfo, #dump, #dump_all, #dump_image, #dump_mark, #dump_tag, #dump_text, #dump_window, #edit_redo, #edit_reset, #edit_separator, #edit_undo, #get_displaychars, #image_cget, #image_configinfo, #image_configure, #image_names, #index, #init_instance_variable, #insert, #mark_gravity, #mark_names, #mark_next, #mark_previous, #mark_set, #mark_unset, #modified, #modified=, #modified?, new, #peer_names, #replace, #rsearch, #rsearch_with_length, #search, #search_with_length, #set_current, #set_insert, #tag_add, #tag_bind, #tag_bind_append, #tag_bind_remove, #tag_bindinfo, #tag_delete, #tag_lower, #tag_names, #tag_nextrange, #tag_prevrange, #tag_raise, #tag_ranges, #tag_remove, #tagid2obj, #text_copy, #text_cut, #text_paste, #tksearch, #tksearch_with_count, #value, #value=, #window_names, #xview_pickplace, #yview_pickplace

Methods included from TkTextTagConfig

#current_tag_configinfo, #current_window_configinfo, #tag_cget, #tag_configinfo, #tag_configure, #window_cget, #window_configinfo, #window_configure

Methods included from TkItemConfigMethod

#current_itemconfiginfo, #itemcget, #itemconfiginfo, #itemconfigure, #tagid

Methods included from TkItemConfigOptkeys

#__conv_item_keyonly_opts, #itemconfig_hash_kv

Methods included from TkTreatItemFont

#kanjifont_copy, #kanjitagfont_configure, #latintagfont_configure, #latintagfont_copy, #tagfont_configinfo, #tagfont_configure, #tagfont_copy

Methods inherited from TkTextWin

#bbox, #delete, #get, #insert, #scan_dragto, #scan_mark, #see

Methods inherited from TkWindow

#bind_class, #bindtags, #bindtags=, #bindtags_shift, #bindtags_unshift, #caret, #colormodel, #command, #cursor_propagate, #cursor_restore, #database_class, database_class, #database_classname, database_classname, #destroy, #eventloop_wait_destroy, #eventloop_wait_visibility, #exist?, #grab, #grab_current, #grab_release, #grab_set, #grab_set_global, #grab_status, #grid, #grid_bbox, #grid_columnconfig, #grid_columnconfiginfo, #grid_config, #grid_forget, #grid_in, #grid_info, #grid_location, #grid_propagate, #grid_remove, #grid_rowconfig, #grid_rowconfiginfo, #grid_size, #grid_slaves, #initialize, #lower, #pack, #pack_config, #pack_forget, #pack_in, #pack_info, #pack_propagate, #pack_slaves, #place, #place_config, #place_configinfo, #place_forget, #place_in, #place_info, #place_slaves, #raise, #set_focus, #thread_wait_destroy, #thread_wait_visibility, #tktrans_get_image, #tktrans_set_image, to_eval, #wait_destroy, #wait_visibility

Methods included from TkBindCore

#bind, #bind_append, #bind_remove, #bindinfo

Methods included from TkWinfo

appname, atom, atomname, cells, children, classname, colormapfull, containing, depth, exist?, fpixels, geometry, height, id, interps, manager, mapped?, parent, pixels, pointerx, pointerxy, pointery, reqheight, reqwidth, rgb, rootx, rooty, screen, screencells, screendepth, screenheight, screenmmheight, screenmmwidth, screenvisual, screenwidth, server, toplevel, viewable, visual, visualid, visualsavailable, vrootheight, vrootwidth, vrootx, vrooty, widget, width, #winfo_appname, #winfo_atom, #winfo_atomname, #winfo_cells, #winfo_children, #winfo_classname, #winfo_colormapfull, #winfo_containing, #winfo_depth, #winfo_exist?, #winfo_fpixels, #winfo_geometry, #winfo_height, #winfo_id, #winfo_interps, #winfo_manager, #winfo_mapped?, #winfo_parent, #winfo_pixels, #winfo_pointerx, #winfo_pointerxy, #winfo_pointery, #winfo_reqheight, #winfo_reqwidth, #winfo_rgb, #winfo_rootx, #winfo_rooty, #winfo_screen, #winfo_screencells, #winfo_screendepth, #winfo_screenheight, #winfo_screenmmheight, #winfo_screenmmwidth, #winfo_screenvisual, #winfo_screenwidth, #winfo_server, #winfo_toplevel, #winfo_viewable, #winfo_visual, #winfo_visualid, #winfo_visualsavailable, #winfo_vrootheight, #winfo_vrootwidth, #winfo_vrootx, #winfo_vrooty, #winfo_widget, #winfo_width, #winfo_x, #winfo_y, x, y

Methods included from Tk::TkDND::Shape

package_name, package_patchlevel, package_version, #shape_bounds, #shape_get, #shape_offset, #shape_set, #shape_update, version

Methods included from Tk::TkDND::DND

#dnd_bindsource, #dnd_bindsource_info, #dnd_bindtarget, #dnd_bindtarget_info, #dnd_clearsource, #dnd_cleartarget, #dnd_drag, version

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 TkConfigMethod

#[], #[]=, #cget, #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

Dynamic Method Handling

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

Instance Method Details

#get_scrollbarwidthObject

get/set width of scrollbar



108
109
110
# File 'sample/tktextframe.rb', line 108

def get_scrollbarwidth
  @v_scroll.width
end

#get_textborderwidthObject



91
92
93
# File 'sample/tktextframe.rb', line 91

def get_textborderwidth
  @text.borderwidth
end

#hscroll(mode, wrap_mode = "char") ⇒ Object

horizontal scrollbar : ON/OFF



129
130
131
132
133
134
135
136
137
138
139
# File 'sample/tktextframe.rb', line 129

def hscroll(mode, wrap_mode="char")
  st = TkGrid.info(@h_scroll)
  if mode && st.size == 0 then
    @h_scroll.grid('row'=>1, 'column'=>0, 'sticky'=>'ew')
    wrap 'none'  # => self.wrap('none')
  elsif !mode && st.size != 0 then
    @h_scroll.ungrid
    wrap wrap_mode  # => self.wrap(wrap_mode)
  end
  self
end

#set_scrollbarwidth(width) ⇒ Object Also known as: scrollbarwidth



111
112
113
114
# File 'sample/tktextframe.rb', line 111

def set_scrollbarwidth(width)
  @v_scroll.width(width)
  @h_scroll.width(width)
end

#set_textborderwidth(width) ⇒ Object

get/set borderwidth of text widget



88
89
90
# File 'sample/tktextframe.rb', line 88

def set_textborderwidth(width)
  @text.borderwidth(width)
end

#textbackground(color = nil) ⇒ Object

set background color of text widget



69
70
71
72
73
74
75
# File 'sample/tktextframe.rb', line 69

def textbackground(color = nil)
  if color
    @text.background(color)
  else
    @text.background
  end
end

#textbg_infoObject



77
78
79
80
81
82
83
84
85
# File 'sample/tktextframe.rb', line 77

def textbg_info
  info = @text.configinfo(:background)
  if TkComm::GET_CONFIGINFO_AS_ARRAY
    info[0] = 'textbackground'
    info
  else # ! TkComm::GET_CONFIGINFO_AS_ARRAY
    {'textbackground' => info['background']}
  end
end

#textborderwidth(width = nil) ⇒ Object



94
95
96
97
98
99
100
# File 'sample/tktextframe.rb', line 94

def textborderwidth(width = nil)
  if width
    set_textborderwidth(width)
  else
    get_textborderwidth
  end
end

#textrelief(type) ⇒ Object

set relief of text widget



103
104
105
# File 'sample/tktextframe.rb', line 103

def textrelief(type)
  @text.relief(type)
end

#vscroll(mode) ⇒ Object

vertical scrollbar : ON/OFF



118
119
120
121
122
123
124
125
126
# File 'sample/tktextframe.rb', line 118

def vscroll(mode)
  st = TkGrid.info(@v_scroll)
  if mode && st.size == 0 then
    @v_scroll.grid('row'=>0, 'column'=>1, 'sticky'=>'ns')
  elsif !mode && st.size != 0 then
    @v_scroll.ungrid
  end
  self
end