Struct tk::cmd::TkRoot

pub struct TkRoot<Inst: TkInstance>(_);

Implementations

impl<Inst: TkInstance> TkRoot<Inst>

pub fn configure<Opts>( &self, opts: impl Into<PathOptsWidgets<Opts, ()>> ) -> InterpResult<()>where Opts: IntoHomoTuple<OptPair>,

pub fn as_toplevel(&self) -> TkToplevel<Inst>

pub fn grab(&self) -> InterpResult<()>

pub fn grab_global(&self) -> InterpResult<()>

pub fn grab_set_current(&self) -> InterpResult<()>

pub fn grab_release(&self) -> InterpResult<()>

pub fn grab_set(&self) -> InterpResult<()>

pub fn grab_set_global(&self) -> InterpResult<()>

pub fn grab_status(&self) -> InterpResult<()>

Methods from Deref<Target = Widget<Inst>>

pub fn path(&self) -> &'static str

pub fn add_widgets<Widgs, Shape>( &self, path_widgets: PathOptsWidgets<(), Widgs> ) -> InterpResult<CreatedWidgets<Inst>>where Widgs: ConvertTuple, <Widgs as ConvertTuple>::Output: DomForest<(&'static str, &'static str), OptPair, Shape>,

Adds child widget(s) containing hierachical trees of children widgets, including geometry managers.

Examples

use tk::*;
use tk::cmd::*;

fn main() -> TkResult<()> {
    let tk = make_tk!()?;
    let root = tk.root();

    root.add_widgets(
        -pack(
            -button( -text("hello,tk!") -command("") )
            -pack( -button( -text("oops") ))
            -frame( -pack(
                -button( -text("exit") -command("destroy .") )
                -option_menu( "optmenu1", "my_opt", &[ "ALPHA", "BETA", "GAMMA" ])
            ))
        )
        -pack( -expand(1)
            -button( -text("demo") )
            -button( -text("demo") )
            -option_menu( "optmenu2", "your_opt", &[ "alpha", "beta", "gamma" ])
        )
    )?;

    Ok( main_loop() )
}

pub fn pack_configure<Opts>( &self, opts: impl Into<PathOptsWidgets<Opts, ()>> ) -> InterpResult<()>where Opts: IntoHomoTuple<TkPackOpt> + IntoHomoTuple<OptPair>,

pub fn pack_forget(&self) -> InterpResult<()>

pub fn pack_info(&self) -> InterpResult<HashMap<String, Obj>>

pub fn grid_configure<Opts>( &self, opts: impl Into<PathOptsWidgets<Opts, ()>> ) -> InterpResult<()>where Opts: IntoHomoTuple<TkGridOpt> + IntoHomoTuple<OptPair>,

pub fn grid_forget(&self) -> InterpResult<()>

pub fn grid_info(&self) -> InterpResult<HashMap<String, Obj>>

pub fn place_configure<Opts>( &self, opts: impl Into<PathOptsWidgets<Opts, ()>> ) -> InterpResult<()>where Opts: IntoHomoTuple<TkPlaceOpt> + IntoHomoTuple<OptPair>,

pub fn place_forget(&self) -> InterpResult<()>

pub fn place_info(&self) -> InterpResult<HashMap<String, Obj>>

pub fn grid_slaves<Opts>( &self, opts: impl Into<PathOptsWidgets<Opts, ()>> ) -> Result<Vec<Widget<Inst>>, Enum3<InterpError, NotList, WidgetNotFound>>where Opts: IntoHomoTuple<TkRowColumnOpt> + IntoHomoTuple<OptPair>,

pub fn pack_slaves( &self ) -> Result<Vec<Widget<Inst>>, Enum3<InterpError, NotList, WidgetNotFound>>

pub fn place_slaves( &self ) -> Result<Vec<Widget<Inst>>, Enum3<InterpError, NotList, WidgetNotFound>>

pub fn has_used_input_methods(&self) -> InterpResult<bool>

pub fn use_input_methods(&self, should_use: bool) -> InterpResult<()>

pub fn inactive(&self) -> InterpResult<c_longlong>

pub fn inactive_reset(&self) -> InterpResult<c_longlong>

pub fn scaling(&self) -> InterpResult<c_double>

pub fn set_scaling(&self, number: c_double) -> InterpResult<()>

pub fn lower(&self) -> InterpResult<()>

pub fn lower_below(&self, below_this: &Self) -> InterpResult<()>

pub fn raise(&self) -> InterpResult<()>

pub fn raise_above(&self, above_this: &Self) -> InterpResult<()>

pub fn bind( &self, sequence: impl Into<TkEventSeq>, script: impl Into<Obj> ) -> InterpResult<()>

pub fn bind_more( &self, sequence: impl Into<TkEventSeq>, script: impl Into<Obj> ) -> InterpResult<()>

pub fn bindtags(&self, tags: &[&str]) -> InterpResult<()>

pub fn bindedtags(&self) -> Result<Vec<String>, Enum2<InterpError, NotList>>

pub fn event_generate<Opts>( &self, event: TkEvent, opts: impl Into<PathOptsWidgets<Opts, ()>> ) -> InterpResult<()>where Opts: IntoHomoTuple<TkEventOpt> + IntoHomoTuple<OptPair>,

Generates a window event and arranges for it to be processed just as if it had come from the window system. event provides a basic description of the event, such as shift_button_2() or paste(). If Window is empty the whole screen is meant, and coordinates are relative to the screen. Option-value pairs may be used to specify additional attributes of the event, such as the x and y mouse position; see EVENT FIELDS for more. If the -when option is not specified, the event is processed immediately: all of the handlers for the event will complete before the event generate command returns. If the -when option is specified then it determines when the event is processed. Certain events, such as key events, require that the window has focus to receive the event properly.

pub fn grid_anchor(&self, anchor: impl Into<Obj>) -> InterpResult<()>

pub fn grid_bbox( &self, grids: Grids ) -> Result<TkBBox, Enum2<DeError, InterpError>>

pub fn grid_columnconfigure<Opts>( &self, index: impl Into<Obj>, opts: impl Into<PathOptsWidgets<Opts, ()>> ) -> InterpResult<()>where Opts: IntoHomoTuple<TkGridColumnConfigureOpt> + IntoHomoTuple<OptPair>,

pub fn grid_location( &self, x: c_int, y: c_int ) -> Result<Grid, Enum2<DeError, InterpError>>

pub fn grid_propagate(&self, do_propagate: bool) -> InterpResult<()>

pub fn grid_propagated(&self) -> InterpResult<bool>

pub fn grid_rowconfigure<Opts>( &self, index: impl Into<Obj>, opts: impl Into<PathOptsWidgets<Opts, ()>> ) -> InterpResult<()>where Opts: IntoHomoTuple<TkGridRowConfigureOpt> + IntoHomoTuple<OptPair>,

pub fn grid_remove(&self) -> InterpResult<()>

pub fn grid_size(&self) -> Result<Size, Enum2<DeError, InterpError>>

pub fn pack_propagate(&self, do_propagate: bool) -> InterpResult<()>

pub fn pack_propagated(&self) -> InterpResult<bool>

pub fn focus(&self) -> InterpResult<()>

pub fn focus_displayof(&self) -> InterpResult<Obj>

pub fn focus_force(&self) -> InterpResult<()>

pub fn focus_lastfor(&self) -> InterpResult<Obj>

pub fn winfo_atom(&self, name: &str) -> InterpResult<c_longlong>

pub fn winfo_atom_name(&self, id: c_longlong) -> InterpResult<String>

pub fn winfo_cells(&self) -> InterpResult<c_int>

pub fn winfo_children( &self ) -> Result<Vec<Widget<Inst>>, Enum3<InterpError, NotList, WidgetNotFound>>

pub fn winfo_class(&self) -> InterpResult<String>

pub fn winfo_colormap_full(&self) -> InterpResult<bool>

pub fn winfo_containing( &self, root_x: c_int, root_y: c_int ) -> InterpResult<String>

pub fn winfo_depth(&self) -> InterpResult<c_int>

pub fn winfo_fpixels(&self, number: TkDistance) -> InterpResult<c_double>

pub fn winfo_geometry( &self ) -> Result<TkGeometry, Enum2<InterpError, TkGeometryParseError>>

pub fn winfo_height(&self) -> InterpResult<c_int>

pub fn winfo_id(&self) -> InterpResult<String>

pub fn winfo_interps(&self) -> Result<Vec<String>, Enum2<InterpError, NotList>>

Returns a list whose members are the names of all Tcl interpreters (e.g. all Tk-based applications) currently registered for the display of window.

pub fn winfo_ismapped(&self) -> InterpResult<bool>

pub fn winfo_manager(&self) -> InterpResult<String>

Returns the name of the geometry manager currently responsible for window, or an empty string if window is not managed by any geometry manager. The name is usually the name of the Tcl command for the geometry manager, such as pack or place. If the geometry manager is a widget, such as canvases or text, the name is the widget’s class command, such as canvas.

Examples

use tk::*;
use tk::cmd::*;

fn main() -> TkResult<()> {
    let mut tk = make_tk!()?;
    let root = tk.root();
    let label = root.add_label( -text("lorum") )?.pack(())?;
    Ok( assert_eq!( label.winfo_manager().unwrap().as_str(), "pack" ))
}

pub fn winfo_name(&self) -> InterpResult<String>

pub fn winfo_parent(&self) -> InterpResult<Option<String>>

pub fn winfo_pathname(&self, id: c_ulong) -> InterpResult<String>

pub fn winfo_pixels(&self, number: TkDistance) -> InterpResult<c_int>

pub fn winfo_pointerx(&self) -> InterpResult<Option<c_int>>

pub fn winfo_pointerxy( &self ) -> Result<Option<TkCoord>, Enum2<DeError, InterpError>>

pub fn winfo_pointery(&self) -> InterpResult<Option<c_int>>

pub fn winfo_reqheight(&self) -> InterpResult<c_int>

pub fn winfo_reqwidth(&self) -> InterpResult<c_int>

pub fn winfo_rgb( &self, color: TkColor<'_> ) -> Result<TkRGB, Enum2<DeError, InterpError>>

pub fn winfo_rootx(&self) -> InterpResult<c_int>

pub fn winfo_rooty(&self) -> InterpResult<c_int>

pub fn winfo_screen( &self ) -> Result<TkScreenName, Enum2<InterpError, TkScreenNameParseError>>

pub fn winfo_screencells(&self) -> InterpResult<c_int>

pub fn winfo_screendepth(&self) -> InterpResult<c_int>

pub fn winfo_screenheight(&self) -> InterpResult<c_int>

pub fn winfo_screenmmheight(&self) -> InterpResult<c_int>

pub fn winfo_screenmmwidth(&self) -> InterpResult<c_int>

pub fn winfo_screenvisual( &self ) -> Result<TkVisualClass, Enum2<DeError, InterpError>>

pub fn winfo_screenwidth(&self) -> InterpResult<c_int>

pub fn winfo_server(&self) -> InterpResult<String>

pub fn winfo_toplevel(&self) -> InterpResult<TkToplevel<Inst>>

pub fn winfo_viewable(&self) -> InterpResult<bool>

pub fn winfo_visual(&self) -> Result<TkVisualClass, Enum2<DeError, InterpError>>

pub fn winfo_visualid(&self) -> InterpResult<String>

pub fn winfo_visualsavailable( &self ) -> Result<Vec<(TkVisualClass, c_int)>, Enum4<DeError, InterpError, NotList, NotSeqOf<(TkVisualClass, c_int)>>>

pub fn winfo_visualsavailable_includeids( &self ) -> Result<Vec<(TkVisualClass, c_int, String)>, Enum4<DeError, InterpError, NotList, NotSeqOf<(TkVisualClass, c_int, String)>>>

pub fn winfo_vrootheight(&self) -> InterpResult<c_int>

pub fn winfo_vrootwidth(&self) -> InterpResult<c_int>

pub fn winfo_vrootx(&self) -> InterpResult<c_int>

pub fn winfo_vrooty(&self) -> InterpResult<c_int>

pub fn winfo_width(&self) -> InterpResult<c_int>

pub fn winfo_x(&self) -> InterpResult<c_int>

pub fn winfo_y(&self) -> InterpResult<c_int>

pub fn set_wm_aspect( &self, min_numer: impl Into<Obj>, min_denom: impl Into<Obj>, max_numer: impl Into<Obj>, max_denom: impl Into<Obj> ) -> InterpResult<()>

pub fn wm_aspect( &self ) -> Result<(c_int, c_int, c_int, c_int), Enum2<DeError, InterpError>>

pub fn wm_clear_aspect(&self) -> InterpResult<()>

pub fn wm_attributes(&self) -> InterpResult<Obj>

pub fn set_wm_attributes<Opts>( &self, opts: impl Into<PathOptsWidgets<Opts, ()>> ) -> InterpResult<()>where Opts: IntoHomoTuple<TkWmAttributesOpt> + IntoHomoTuple<OptPair>,

pub fn set_wm_client(&self, name: &str) -> InterpResult<()>

pub fn wm_client(&self) -> InterpResult<String>

pub fn set_wm_colormapwindows( &self, windows: Vec<Widget<Inst>> ) -> InterpResult<()>

pub fn wm_colormapwindows( &self ) -> Result<Vec<Widget<Inst>>, Enum3<InterpError, NotList, WidgetNotFound>>

pub fn set_wm_command(&self, command: impl Into<Obj>) -> InterpResult<()>

pub fn wm_command(&self) -> InterpResult<Obj>

pub fn wm_deiconify(&self) -> InterpResult<()>

pub fn set_wm_focusmodel(&self, focus_model: TkFocusModel) -> InterpResult<()>

pub fn wm_focusmodel(&self) -> Result<TkFocusModel, Enum2<DeError, InterpError>>

pub fn wm_forget(&self) -> InterpResult<()>

pub fn wm_frame(&self) -> InterpResult<String>

pub fn set_wm_geometry(&self, geometry: TkGeometry) -> InterpResult<()>

pub fn wm_geometry( &self ) -> Result<TkGeometry, Enum2<InterpError, TkGeometryParseError>>

pub fn set_wm_grid(&self, acceptable_size: TkAcceptableSize) -> InterpResult<()>

pub fn wm_grid( &self ) -> Result<TkAcceptableSize, Enum3<InterpError, NotList, TkAcceptableSizeParseError>>

pub fn set_wm_group(&self, leader: Widget<Inst>) -> InterpResult<()>

pub fn clear_wm_group(&self) -> InterpResult<()>

pub fn wm_group(&self) -> InterpResult<Option<Widget<Inst>>>

pub fn set_wm_iconbitmap(&self, bitmap: &str) -> InterpResult<()>

pub fn clear_wm_iconbitmap(&self) -> InterpResult<()>

pub fn wm_iconbitmap(&self) -> InterpResult<String>

pub fn wm_iconify(&self) -> InterpResult<()>

pub fn set_wm_iconmask(&self, bitmap: &str) -> InterpResult<()>

pub fn clear_wm_iconmask(&self) -> InterpResult<()>

pub fn wm_iconmask(&self) -> InterpResult<Option<String>>

pub fn set_wm_iconname(&self, name: &str) -> InterpResult<()>

pub fn wm_iconname(&self) -> InterpResult<String>

pub fn set_wm_iconphoto( &self, image: &str, extra_images: Option<&[&str]> ) -> InterpResult<()>

pub fn set_wm_iconposition(&self, x: c_int, y: c_int) -> InterpResult<()>

pub fn clear_wm_iconposition(&self) -> InterpResult<()>

pub fn wm_iconposition(&self) -> Result<TkCoord, Enum2<DeError, InterpError>>

pub fn set_wm_iconwindow(&self, icon_window: Widget<Inst>) -> InterpResult<()>

pub fn clear_wm_iconwindow(&self) -> InterpResult<()>

pub fn wm_iconwindow(&self) -> InterpResult<Option<Widget<Inst>>>

pub fn set_wm_maxsize(&self, width: c_int, height: c_int) -> InterpResult<()>

pub fn wm_maxsize(&self) -> Result<TkSize, Enum2<DeError, InterpError>>

pub fn set_wm_minsize(&self, width: c_int, height: c_int) -> InterpResult<()>

pub fn wm_minsize(&self) -> Result<TkSize, Enum2<DeError, InterpError>>

pub fn set_wm_overrideredirect( &self, overrideredirect: bool ) -> InterpResult<()>

pub fn wm_overrideredirect(&self) -> InterpResult<bool>

pub fn set_wm_positionfrom(&self, who: TkRequester) -> InterpResult<()>

pub fn clear_wm_positionfrom(&self) -> InterpResult<()>

pub fn wm_positionfrom( &self ) -> Result<Option<TkRequester>, Enum2<InterpError, TkRequesterParseError>>

pub unsafe fn set_wm_protocol( &self, name: &str, command: impl Into<Obj> ) -> InterpResult<()>

pub fn clear_wm_protocol_command(&self, name: &str) -> InterpResult<Obj>

pub unsafe fn wm_protocol_command( &self, name: &str ) -> InterpResult<Option<Obj>>

pub fn wm_protocol( &self ) -> Result<Vec<TkHandler>, Enum3<NotSeqOf<TkHandler>, NotList, InterpError>>

pub fn set_wm_resizable( &self, width_resizable: bool, height_resizable: bool ) -> InterpResult<()>

pub fn wm_resizable( &self ) -> Result<TkResizable, Enum2<InterpError, TkResizableParseError>>

pub fn set_wm_sizefrom(&self, who: TkRequester) -> InterpResult<()>

pub fn clear_wm_sizefrom(&self) -> InterpResult<()>

pub fn wm_sizefrom( &self ) -> Result<Option<TkRequester>, Enum2<InterpError, TkRequesterParseError>>

pub fn wm_stackorder( &self ) -> Result<Vec<Widget<Inst>>, Enum3<InterpError, NotList, WidgetNotFound>>

pub fn wm_stackorder_isabove(&self, widget: &Widget<Inst>) -> InterpResult<bool>

pub fn wm_stackorder_isbelow(&self, widget: &Widget<Inst>) -> InterpResult<bool>

pub fn set_wm_state(&self, new_state: TkState) -> InterpResult<()>

pub fn wm_state(&self) -> Result<TkState, Enum2<DeError, InterpError>>

pub fn set_wm_title(&self, title: impl Into<Obj>) -> InterpResult<()>

pub fn wm_title(&self) -> InterpResult<String>

pub fn set_wm_transient(&self, master: &TkToplevel<Inst>) -> InterpResult<()>

pub fn clear_wm_transient(&self) -> InterpResult<()>

pub fn wm_transient(&self) -> InterpResult<Option<TkToplevel<Inst>>>

pub fn wm_withdraw(&self) -> InterpResult<()>

pub fn font_actual<'a, Opt, Opts>( &self, font: Font<'a, Opts>, _option: Opt, ch: Option<char> ) -> InterpResult<Obj>where Opt: TkOption + Into<TkFontOpt>, Opts: IntoHomoTuple<TkFontOpt> + IntoHomoTuple<OptPair>,

Returns the value of the actual attributes that are obtained when font is used on window’s display; the actual attribute obtained may differ from the attribute requested due to platform-dependent limitations, such as the availability of font families and point sizes. If the char argument is supplied, the font attributes returned will be those of the specific font used to render that character, which will be different from the base font if the base font does not contain the given character.

pub fn font_actual_get_all<'a, Opts>( &self, font: Font<'a, Opts> ) -> InterpResult<Obj>where Opts: IntoHomoTuple<TkFontOpt> + IntoHomoTuple<OptPair>,

Returns a list of all the atual attributes and their values that are obtained when font is used on window’s display; the actual attributes obtained may differ from the attributes requested due to platform-dependent limitations, such as the availability of font families and point sizes. If the char argument is supplied, the font attributes returned will be those of the specific font used to render that character, which will be different from the base font if the base font does not contain the given character.

pub fn font_families(&self) -> Result<Vec<String>, Enum2<InterpError, NotList>>

pub fn font_measure<'a, Opts>( &self, font: Font<'a, Opts>, text: impl Into<String> ) -> InterpResult<c_longlong>where Opts: IntoHomoTuple<TkFontOpt> + IntoHomoTuple<OptPair>,

pub fn font_metrics<'a, Opt, Opts>( &self, font: Font<'a, Opts>, _opt: Opt ) -> InterpResult<Obj>where Opt: TkOption + Into<TkFontOpt>, Opts: IntoHomoTuple<TkFontOpt> + IntoHomoTuple<OptPair>,

pub fn font_metrics_get_all<'a, Opts>( &self, font: Font<'a, Opts> ) -> Result<Vec<OptPair>, Enum3<InterpError, NotList, NotSeqOf<OptPair>>>where Opts: IntoHomoTuple<TkFontOpt> + IntoHomoTuple<OptPair>,

Trait Implementations

impl<Inst: TkInstance> AddMenus<Inst> for TkRoot<Inst>

fn add_menus<Widgs, Opts, Shape>( &self, path_opts_widgets: PathOptsWidgets<Opts, Widgs> ) -> InterpResult<CreatedWidgets<Inst>>where Opts: IntoHomoTuple<TkMenuOpt> + IntoHomoTuple<OptPair>, Widgs: ConvertTuple, <Widgs as ConvertTuple>::Output: DomForest<(&'static str, &'static str), OptPair, Shape>,

impl<Inst: Clone + TkInstance> Clone for TkRoot<Inst>

fn clone(&self) -> TkRoot<Inst>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Inst: TkInstance> Deref for TkRoot<Inst>

type Target = Widget<Inst>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<Inst: Copy + TkInstance> Copy for TkRoot<Inst>