api::sidebar Namespace Reference

Functions
	get_selected_indices interp pname
	get_info interp pname sb_index attr
	set_info interp pname sb_index attr value

Function Documentation

get_info()

api::sidebar::get_info			interp pname sb_index attr

Returns

Returns the value for the specified attribute of the file/directory in the sidebar with the given index.

Parameters

sb_index

Sidebar index of file/directory in the sidebar

attr

Attribute to return the value of. Valid attribute names are: fname : Normalized name file or directory file_index : If not set, indicates the file has not been opened in the editor; otherwise, specifies the file index of the opened file. is_dir : True if the given sidebar item is a directory. is_open : True if the given sidebar item is in the open state. children : Ordered list of children items of the given sidebar directory.

Definition at line 821 of file api.tcl.

    proc get_info {interp pname sb_index attr} {

      return [::sidebar::get_info $sb_index $attr]

    }

get_selected_indices()

api::sidebar::get_selected_indices			interp pname

Returns

Returns the selected sidebar file index.

Definition at line 798 of file api.tcl.

    proc get_selected_indices {interp pname} {

      return [::sidebar::get_selected_indices]

    }

set_info()

api::sidebar::set_info			interp pname sb_index attr value

Changes the state of the specified sidebar item to the given value.

Parameters

sb_index	Sidebar index of file/directory in the sidebar
attr	Attribute to set the value of. Valid attribute names are: open : If set to 1, causes the sidebar item to be opened; otherwise, if set to 0, causes the sidebar item to be closed.

Definition at line 836 of file api.tcl.

    proc set_info {interp pname sb_index attr value} {

      ::sidebar::set_info $sb_index $attr $value

    }