api::menu Namespace Reference

Functions
	exists interp pname mnu_path
	enabled interp pname mnu_path
	selected interp pname mnu_path
	invoke interp pname mnu_path

Function Documentation

enabled()

api::menu::enabled			interp pname mnu_path

Definition at line 1096 of file api.tcl.

    proc enabled {interp pname mnu_path} {

      set menu_list [split $mnu_path /]

      if {![catch { menus::get_menu [lrange $menu_list 0 end-1]} mnu]} {
        if {![catch { menus::get_menu_index $mnu [lindex $menu_list end]} index] && ($index ne "none")} {
          return [expr {[$mnu entrycget $index -state] eq "normal"}]
        }
      }

      return 0

    }

exists()

api::menu::exists			interp pname mnu_path

Returns true if the given menu path exists in the main menubar; otherwise, returns false. The 'mnu_path' is a slash-separated (/) path to a menu item. The menu path must match the menu strings exactly (case-sensitive).

Definition at line 1079 of file api.tcl.

    proc exists {interp pname mnu_path} {

      set menu_list [split $mnu_path /]

      if {![catch { menus::get_menu [lrange $menu_list 0 end-1]} mnu]} {
        if {![catch { menus::get_menu_index $mnu [lindex $menu_list end]} res] && ($res ne "none")} {
          return 1
        }
      }

      return 0

    }

invoke()

api::menu::invoke			interp pname mnu_path

Attempts to invoke the menu item specified by the given menu path.

Definition at line 1133 of file api.tcl.

    proc invoke {interp pname mnu_path} {

      variable not_allowed

      if {[info exists not_allowed($mnu_path)]} {
        return 0
      }

      set menu_list [split $mnu_path /]

      if {![catch { menus::get_menu [lrange $menu_list 0 end-1]} mnu]} {
        if {![catch { menus::get_menu_index $mnu [lindex $menu_list end]} index] && ($index ne "none")} {
          if {![catch { menus::invoke $mnu $index}]} {
            return 1
          }
        }
      }

      return 0

    }

selected()

api::menu::selected			interp pname mnu_path

Returns the current value of the given menu path (only valid for checkbutton or radiobutton menus).

Definition at line 1113 of file api.tcl.

    proc selected {interp pname mnu_path} {

      set menu_list [split $mnu_path /]

      if {![catch { menus::get_menu [lrange $menu_list 0 end-1]} mnu]} {
        if {![catch { menus::get_menu_index $mnu [lindex $menu_list end]} index] && ($index ne "none")} {
          switch  [$mnu type $index] {
            checkbutton { return [expr {[set [$mnu entrycget $index -variable]] eq [$mnu entrycget $index -onvalue]}]}
            radiobutton { return [expr {[set [$mnu entrycget $index -variable]] eq [$mnu entrycget $index -value]}]}
            default     { return ""}
          }
        }
      }

      return ""

    }