Class: Tk::Iwidgets::Notebook

Inherits:
Tk::Itk::Widget show all
Includes:
TkItemConfigMethod
Defined in:
ext/lib/tkextlib/iwidgets/notebook.rb,
ext/lib/tkextlib/iwidgets/notebook.rb

Constant Summary collapse

TkCommandNames = 
['::iwidgets::notebook'.freeze].freeze
WidgetClassName = 
'Notebook'.freeze

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::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 TkDND::Shape

TkDND::Shape::PACKAGE_NAME

Instance Method Summary collapse

Methods included from TkItemConfigMethod

__IGNORE_UNKNOWN_CONFIGURE_OPTION__, #__check_available_itemconfigure_options, #__current_itemconfiginfo, __set_IGNORE_UNKNOWN_CONFIGURE_OPTION__!, #current_itemconfiginfo, #itemcget, #itemcget_strict, #itemconfiginfo, #itemconfigure

Methods included from TkItemConfigOptkeys

#__conv_item_keyonly_opts, #itemconfig_hash_kv

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 TkTreatItemFont

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

Methods inherited from Tk::Itk::Archetype

#__destroy_hook__, #component, #component_invoke, #component_obj, #component_path, to_eval

Methods inherited from TkWindow

_widget_inspect_full_=, _widget_inspect_full_?, #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_anchor, #grid_bbox, #grid_column, #grid_columnconfig, #grid_columnconfiginfo, #grid_config, #grid_forget, #grid_in, #grid_info, #grid_location, #grid_propagate, #grid_remove, #grid_row, #grid_rowconfig, #grid_rowconfiginfo, #grid_size, #grid_slaves, #initialize, #inspect, #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

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

Methods included from TkEvent

#install_bind, #install_bind_for_event_class

Methods included from TkDND::DND

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

Methods included from TkDND::Shape

package_name, package_patchlevel, package_version, #shape_bounds, #shape_get, #shape_offset, #shape_set, #shape_update, 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

#[], #[]=, __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 inherited from TkKernel

new

Constructor Details

This class inherits a constructor from TkWindow

Dynamic Method Handling

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

Instance Method Details

#add(keys = {}) ⇒ Object 



60
61
62
 
# File 'ext/lib/tkextlib/iwidgets/notebook.rb', line 60

def add(keys={})
  window(tk_call(@path, 'add', *hash_kv(keys)))
end

#child_site(idx) ⇒ Object 



68
69
70
71
72
73
 
# File 'ext/lib/tkextlib/iwidgets/notebook.rb', line 68

def child_site(idx)
  if (new_idx = self.index(idx)) < 0
    new_idx = tagid(idx)
  end
  window(tk_call(@path, 'childsite', new_idx))
end

#child_site_list ⇒ Object 



64
65
66
 
# File 'ext/lib/tkextlib/iwidgets/notebook.rb', line 64

def child_site_list
  list(tk_call(@path, 'childsite'))
end

#delete(idx1, idx2 = nil) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'ext/lib/tkextlib/iwidgets/notebook.rb', line 75

def delete(idx1, idx2=nil)
  if (new_idx1 = self.index(idx1)) < 0
    new_idx1 = tagid(idx1)
  end
  if idx2
    if (new_idx2 = self.index(idx2)) < 0
      new_idx2 = tagid(idx2)
    end
    tk_call(@path, 'delete', new_idx1, new_idx2)
  else
    tk_call(@path, 'delete', new_idx1)
  end
  self
end

#index(idx) ⇒ Object 



90
91
92
 
# File 'ext/lib/tkextlib/iwidgets/notebook.rb', line 90

def index(idx)
  number(tk_call(@path, 'index', tagid(idx)))
end

#insert(idx, keys = {}) ⇒ Object 



94
95
96
97
98
99
 
# File 'ext/lib/tkextlib/iwidgets/notebook.rb', line 94

def insert(idx, keys={})
  if (new_idx = self.index(idx)) < 0
    new_idx = tagid(idx)
  end
  window(tk_call(@path, 'insert', new_idx, *hash_kv(keys)))
end

#next ⇒ Object 



101
102
103
104
 
# File 'ext/lib/tkextlib/iwidgets/notebook.rb', line 101

def next
  tk_call(@path, 'next')
  self
end

#prev ⇒ Object 



106
107
108
109
 
# File 'ext/lib/tkextlib/iwidgets/notebook.rb', line 106

def prev
  tk_call(@path, 'prev')
  self
end

#scrollcommand(cmd = Proc.new) ⇒ Object Also known as: xscrollcommand, yscrollcommand 



119
120
121
122
 
# File 'ext/lib/tkextlib/iwidgets/notebook.rb', line 119

def scrollcommand(cmd=Proc.new)
  configure_cmd 'scrollcommand', cmd
  self
end

#select(idx) ⇒ Object 



111
112
113
114
115
116
117
 
# File 'ext/lib/tkextlib/iwidgets/notebook.rb', line 111

def select(idx)
  if (new_idx = self.index(idx)) < 0
    new_idx = tagid(idx)
  end
  tk_call(@path, 'select', new_idx)
  self
end

#tagid(tagOrId) ⇒ Object 



35
36
37
38
39
40
41
42
 
# File 'ext/lib/tkextlib/iwidgets/notebook.rb', line 35

def tagid(tagOrId)
  if tagOrId.kind_of?(Tk::Itk::Component)
    tagOrId.name
  else
    #_get_eval_string(tagOrId)
    tagOrId
  end
end

#view(*idxs) ⇒ Object Also known as: xview, yview 



148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'ext/lib/tkextlib/iwidgets/notebook.rb', line 148

def view(*idxs)
  if idxs.size == 0
    idx = num_or_str(tk_send_without_enc('view'))
    if idx.kind_of?(Fixnum) && idx < 0
      nil
    else
      idx
    end
  else
    tk_send_without_enc('view', *idxs)
    self
  end
end

#view_moveto(*idxs) ⇒ Object Also known as: xview_moveto, yview_moveto 



164
165
166
 
# File 'ext/lib/tkextlib/iwidgets/notebook.rb', line 164

def view_moveto(*idxs)
  view('moveto', *idxs)
end

#view_scroll(index, what = 'pages') ⇒ Object Also known as: xview_scroll, yview_scroll 



169
170
171
 
# File 'ext/lib/tkextlib/iwidgets/notebook.rb', line 169

def view_scroll(index, what='pages')
  view('scroll', index, what)
end

#xscrollbar(bar = nil) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
 
# File 'ext/lib/tkextlib/iwidgets/notebook.rb', line 126

def xscrollbar(bar=nil)
  if bar
    @scrollbar = bar
    @scrollbar.orient 'horizontal'
    self.scrollcommand {|*arg| @scrollbar.set(*arg)}
    @scrollbar.command {|*arg| self.xview(*arg)}
    Tk.update  # avoid scrollbar trouble
  end
  @scrollbar
end

#yscrollbar(bar = nil) ⇒ Object Also known as: scrollbar 



136
137
138
139
140
141
142
143
144
145
 
# File 'ext/lib/tkextlib/iwidgets/notebook.rb', line 136

def yscrollbar(bar=nil)
  if bar
    @scrollbar = bar
    @scrollbar.orient 'vertical'
    self.scrollcommand {|*arg| @scrollbar.set(*arg)}
    @scrollbar.command {|*arg| self.yview(*arg)}
    Tk.update  # avoid scrollbar trouble
  end
  @scrollbar
end