Class: Tk::RbWidget::ScrollFrame

Inherits:
TkFrame
  • Object
show all
Includes:
TkComposite
Defined in:
sample/scrollframe.rb

Constant Summary collapse

DEFAULT_WIDTH =
200
DEFAULT_HEIGHT =
200

Constants included from Tk

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

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

Instance Method Summary collapse

Methods included from TkComposite

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

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_all, #bind_append_all, #bind_remove_all, #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

Instance Method Details

#bind(*args) ⇒ Object

forbid to change binding of @base frame


160
161
162
# File 'sample/scrollframe.rb', line 160

def bind(*args)
  @frame.bind(*args)
end

#bind_append(*args) ⇒ Object


163
164
165
# File 'sample/scrollframe.rb', line 163

def bind_append(*args)
  @frame.bind_append(*args)
end

#bind_remove(*args) ⇒ Object


166
167
168
# File 'sample/scrollframe.rb', line 166

def bind_remove(*args)
  @frame.bind_remove(*args)
end

#bindinfo(*args) ⇒ Object


169
170
171
# File 'sample/scrollframe.rb', line 169

def bindinfo(*args)
  @frame.bindinfo(*args)
end

#hscroll(mode) ⇒ Object

horizontal scrollbar : ON/OFF


199
200
201
202
203
204
205
206
207
208
209
210
# File 'sample/scrollframe.rb', line 199

def hscroll(mode)
  Tk.update_idletasks
  st = TkGrid.info(@h_scroll)
  if mode && st.size == 0 then
    _reset_scrollregion(true, nil)
  elsif !mode && st.size != 0 then
    _reset_scrollregion(false, nil)
  else
    _reset_scrollregion(nil, nil)
  end
  self
end

#initialize_composite(keys = {}) ⇒ Object


25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'sample/scrollframe.rb', line 25

def initialize_composite(keys={})
  @frame.configure(:width=>DEFAULT_WIDTH, :height=>DEFAULT_HEIGHT)

  # create scrollbars
  @h_scroll = TkScrollbar.new(@frame, 'orient'=>'horizontal')
  @v_scroll = TkScrollbar.new(@frame, 'orient'=>'vertical')

  # create a canvas widget
  @canvas = TkCanvas.new(@frame,
                         :borderwidth=>0, :selectborderwidth=>0,
                         :highlightthickness=>0)

  # allignment
  TkGrid.rowconfigure(@frame, 0, 'weight'=>1, 'minsize'=>0)
  TkGrid.columnconfigure(@frame, 0, 'weight'=>1, 'minsize'=>0)
  @canvas.grid('row'=>0, 'column'=>0, 'sticky'=>'news')
  @frame.grid_propagate(false)

  # assign scrollbars
  @canvas.xscrollbar(@h_scroll)
  @canvas.yscrollbar(@v_scroll)

  # convert hash keys
  keys = _symbolkey2str(keys)

  # check options for the frame
  framekeys = {}
  if keys.key?('classname')
     keys['class'] = keys.delete('classname')
  end
  if @classname = keys.delete('class')
    framekeys['class'] = @classname
  end
  if @colormap  = keys.delete('colormap')
    framekeys['colormap'] = @colormap
  end
  if @container = keys.delete('container')
    framekeys['container'] = @container
  end
  if @visual    = keys.delete('visual')
    framekeys['visual'] = @visual
  end
  if @classname.kind_of? TkBindTag
    @db_class = @classname
    @classname = @classname.id
  elsif @classname
    @db_class = TkDatabaseClass.new(@classname)
  else
    @db_class = self.class
    @classname = @db_class::WidgetClassName
  end

  # create base frame
  @base = TkFrame.new(@canvas, framekeys)

  # embed base frame
  @cwin = TkcWindow.new(@canvas, [0, 0], :window=>@base, :anchor=>'nw')
  @canvas.scrollregion(@cwin.bbox)

  # binding to reset scrollregion
  @base.bind('Configure'){ _reset_scrollregion(nil, nil) }

  # set default receiver of method calls
  @path = @base.path

  # scrollbars ON
  vscroll(keys.delete('vscroll'){true})
  hscroll(keys.delete('hscroll'){true})

  # please check the differences of the following definitions
  option_methods(
    :scrollbarwidth
  )

  # set receiver widgets for configure methods (with alias)
  delegate_alias('scrollbarrelief', 'relief', @h_scroll, @v_scroll)

  # set receiver widgets for configure methods
  delegate('DEFAULT', @base)
  delegate('background', @frame, @base, @canvas, @h_scroll, @v_scroll)
  delegate('width', @frame)
  delegate('height', @frame)
  delegate('activebackground', @h_scroll, @v_scroll)
  delegate('troughcolor', @h_scroll, @v_scroll)
  delegate('repeatdelay', @h_scroll, @v_scroll)
  delegate('repeatinterval', @h_scroll, @v_scroll)
  delegate('borderwidth', @frame)
  delegate('relief', @frame)

  # do configure
  configure keys unless keys.empty?
end

#scrollbarwidth(width = nil) ⇒ Object

set width of scrollbar


174
175
176
177
178
179
180
181
# File 'sample/scrollframe.rb', line 174

def scrollbarwidth(width = nil)
  if width
    @h_scroll.width(width)
    @v_scroll.width(width)
  else
    @h_scroll.width
  end
end

#vscroll(mode) ⇒ Object

vertical scrollbar : ON/OFF


184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'sample/scrollframe.rb', line 184

def vscroll(mode)
  Tk.update_idletasks
  st = TkGrid.info(@v_scroll)
  if mode && st.size == 0 then
    @v_scroll.grid('row'=>0, 'column'=>1, 'sticky'=>'ns')
    _reset_scrollregion(nil, true)
  elsif !mode && st.size != 0 then
    _reset_scrollregion(nil, false)
  else
    _reset_scrollregion(nil, nil)
  end
  self
end