Home Classes Methods

In Files

tk/lib/tkextlib/tile/tpaned.rb

Parent

TkWindow

Included Modules

Tk::Tile::TileWidget

Class/Module Index

Tk::Tile::TPaned

Constants

TkCommandNames
WidgetClassName

Public Class Methods

style(*args) click to toggle source

 
               # File tk/lib/tkextlib/tile/tpaned.rb, line 32
def self.style(*args)
  [self::WidgetClassName, *(args.map!{|a| _get_eval_string(a)})].join('.')
end

Public Instance Methods

add(*args) click to toggle source

 
               # File tk/lib/tkextlib/tile/tpaned.rb, line 36
def add(*args)
  keys = args.pop
  fail ArgumentError, "no window in arguments" unless keys

  if keys && keys.kind_of?(Hash)
    fail ArgumentError, "no window in arguments" if args == []
    opts = hash_kv(keys)
  else
    args.push(keys) if keys
    opts = []
  end

  args.each{|win|
    tk_send_without_enc('add', _epath(win), *opts)
  }
  self
end

current_pane_configinfo(win, key=nil) click to toggle source

Alias for: current_paneconfiginfo

current_paneconfiginfo(win, key=nil) click to toggle source

 
               # File tk/lib/tkextlib/tile/tpaned.rb, line 205
def current_paneconfiginfo(win, key=nil)
  if TkComm::GET_CONFIGINFO_AS_ARRAY
    if key
      conf = paneconfiginfo(win, key)
      {conf[0] => conf[4]}
    else
      ret = {}
      paneconfiginfo(win).each{|conf|
        ret[conf[0]] = conf[4] if conf.size > 2
      }
      ret
    end
  else # ! TkComm::GET_CONFIGINFO_AS_ARRAY
    ret = {}
    paneconfiginfo(win, key).each{|k, conf|
      ret[k] = conf[-1] if conf.kind_of?(Array)
    }
    ret
  end
end

Also aliased as: current_pane_configinfo

forget(pane) click to toggle source

 
               # File tk/lib/tkextlib/tile/tpaned.rb, line 54
def forget(pane)
  pane = _epath(pane)
  tk_send_without_enc('forget', pane)
  self
end

identify(x, y) click to toggle source

 
               # File tk/lib/tkextlib/tile/tpaned.rb, line 233
def identify(x, y)
  num_or_nil(tk_send_without_enc('identify', x, y))
end

insert(pos, win, keys) click to toggle source

 
               # File tk/lib/tkextlib/tile/tpaned.rb, line 60
def insert(pos, win, keys)
  win = _epath(win)
  tk_send_without_enc('insert', pos, win, *hash_kv(keys))
  self
end

pane_cget(pane, slot) click to toggle source

Alias for: panecget

pane_cget_strict(pane, slot) click to toggle source

Alias for: panecget_strict

pane_cget_tkstring(pane, slot) click to toggle source

Alias for: panecget_tkstring

pane_config(pane, key, value=nil) click to toggle source

Alias for: paneconfigure

pane_configinfo(win) click to toggle source

Alias for: paneconfiginfo

pane_configure(pane, key, value=nil) click to toggle source

Alias for: paneconfigure

panecget(pane, slot) click to toggle source

 
               # File tk/lib/tkextlib/tile/tpaned.rb, line 78
def panecget(pane, slot)
  unless TkItemConfigMethod.__IGNORE_UNKNOWN_CONFIGURE_OPTION__
    panecget_strict(pane, slot)
  else
    begin
      panecget_strict(pane, slot)
    rescue => e
      begin
        if current_paneconfiginfo(pane).has_key?(slot.to_s)
          # not tag error & option is known -> error on known option
          fail e
        else
          # not tag error & option is unknown
          nil
        end
      rescue
        fail e  # tag error
      end
    end
  end
end

Also aliased as: pane_cget

panecget_strict(pane, slot) click to toggle source

 
               # File tk/lib/tkextlib/tile/tpaned.rb, line 72
def panecget_strict(pane, slot)
  pane = _epath(pane)
  tk_tcl2ruby(tk_send_without_enc('pane', pane, "-#{slot}"))
end

Also aliased as: pane_cget_strict

panecget_tkstring(pane, slot) click to toggle source

 
               # File tk/lib/tkextlib/tile/tpaned.rb, line 66
def panecget_tkstring(pane, slot)
  pane = _epath(pane)
  tk_send_without_enc('pane', pane, "-#{slot}")
end

Also aliased as: pane_cget_tkstring

paneconfiginfo(win) click to toggle source

 
               # File tk/lib/tkextlib/tile/tpaned.rb, line 121
def paneconfiginfo(win)
  if TkComm::GET_CONFIGINFO_AS_ARRAY
    win = _epath(win)
    if key
      conf = tk_split_list(tk_send_without_enc('pane', win, "-#{key}"))
      conf[0] = conf[0][1..-1]
      if conf[0] == 'hide'
        conf[3] = bool(conf[3]) unless conf[3].empty?
        conf[4] = bool(conf[4]) unless conf[4].empty?
      end
      conf
    else
      tk_split_simplelist(tk_send_without_enc('pane',
                                              win)).collect{|conflist|
        conf = tk_split_simplelist(conflist)
        conf[0] = conf[0][1..-1]
        if conf[3]
          if conf[0] == 'hide'
            conf[3] = bool(conf[3]) unless conf[3].empty?
          elsif conf[3].index('{')
            conf[3] = tk_split_list(conf[3])
          else
            conf[3] = tk_tcl2ruby(conf[3])
          end
        end
        if conf[4]
          if conf[0] == 'hide'
            conf[4] = bool(conf[4]) unless conf[4].empty?
          elsif conf[4].index('{')
            conf[4] = tk_split_list(conf[4])
          else
            conf[4] = tk_tcl2ruby(conf[4])
          end
        end
        conf[1] = conf[1][1..-1] if conf.size == 2 # alias info
        conf
      }
    end
  else # ! TkComm::GET_CONFIGINFO_AS_ARRAY
    win = _epath(win)
    if key
      conf = tk_split_list(tk_send_without_enc('pane', win, "-#{key}"))
      key = conf.shift[1..-1]
      if key == 'hide'
        conf[2] = bool(conf[2]) unless conf[2].empty?
        conf[3] = bool(conf[3]) unless conf[3].empty?
      end
      { key => conf }
    else
      ret = {}
      tk_split_simplelist(tk_send_without_enc('pane',
                                              win)).each{|conflist|
        conf = tk_split_simplelist(conflist)
        key = conf.shift[1..-1]
        if key
          if key == 'hide'
            conf[2] = bool(conf[2]) unless conf[2].empty?
          elsif conf[2].index('{')
            conf[2] = tk_split_list(conf[2])
          else
            conf[2] = tk_tcl2ruby(conf[2])
          end
        end
        if conf[3]
          if key == 'hide'
            conf[3] = bool(conf[3]) unless conf[3].empty?
          elsif conf[3].index('{')
            conf[3] = tk_split_list(conf[3])
          else
            conf[3] = tk_tcl2ruby(conf[3])
          end
        end
        if conf.size == 1
          ret[key] = conf[0][1..-1]  # alias info
        else
          ret[key] = conf
        end
      }
      ret
    end
  end
end

Also aliased as: pane_configinfo

paneconfigure(pane, key, value=nil) click to toggle source

 
               # File tk/lib/tkextlib/tile/tpaned.rb, line 101
def paneconfigure(pane, key, value=nil)
  pane = _epath(pane)
  if key.kind_of? Hash
    params = []
    key.each{|k, v|
      params.push("-#{k}")
      # params.push((v.kind_of?(TkObject))? v.epath: v)
      params.push(_epath(v))
    }
    tk_send_without_enc('pane', pane, *params)
  else
    # value = value.epath if value.kind_of?(TkObject)
    value = _epath(value)
    tk_send_without_enc('pane', pane, "-#{key}", value)
  end
  self
end

Also aliased as: pane_config, pane_configure

panes() click to toggle source

 
               # File tk/lib/tkextlib/tile/tpaned.rb, line 227
def panes
  tk_split_simplelist(tk_send_without_enc('panes')).map{|w|
    (obj = window(w))? obj: w
  }
end

sashpos(idx, newpos=None) click to toggle source

 
               # File tk/lib/tkextlib/tile/tpaned.rb, line 237
def sashpos(idx, newpos=None)
  num_or_str(tk_send_without_enc('sashpos', idx, newpos))
end

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.