Module: Tk::TkCmd

Included in:
Widget
Defined in:
lib/ffi-tk/command/tk_cmd.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.appname(new_name = None) ⇒ Object

If newName is not specified, this command returns the name of the application (the name that may be used in send commands to communicate with the application). If newName is specified, then the name of the application is changed to newName. If the given name is already in use, then a suffix of the form “#2” or “#3” is appended in order to make the name unique. The command’s result is the name actually chosen. newName should not start with a capital letter. This will interfere with option processing, since names starting with capitals are assumed to be classes; as a result, Tk may not be able to find some options for the application. If sends have been disabled by deleting the send command, this command will reenable them and recreate the send command.



64
65
66
 
# File 'lib/ffi-tk/command/tk_cmd.rb', line 64

def appname(new_name = None)
  Tk.execute(:tk, :appname, new_name)
end

.caret(window, options = None) ⇒ Object

Sets and queries the caret location for the display of the specified Tk window window. The caret is the per-display cursor location used for indicating global focus (e.g. to comply with Microsoft Accessibility guidelines), as well as for location of the over-the-spot XIM (X Input Methods) or Windows IME windows. If no options are specified, the last values used for setting the caret are return in option-value pair format. -x and -y represent window-relative coordinates, and -height is the height of the current cursor location, or the height of the specified window if none is given.



79
80
81
82
83
84
85
 
# File 'lib/ffi-tk/command/tk_cmd.rb', line 79

def caret(window, options = None)
  if None == options
    Tk.execute(:tk, :caret, window).tcl_options_to_hash
  else
    Tk.execute_only(:tk, :caret, window, options.to_tcl_options)
  end
end

.inactive(reset = None, window = None) ⇒ Object

Returns a positive integer, the number of milliseconds since the last time the user interacted with the system. If the -displayof option is given then the return value refers to the display of window; otherwise it refers to the display of the application’s main window. tk inactive will return -1, if querying the user inactive time is not supported by the system, and in safe interpreters. If the literal string reset is given as an additional argument, the timer is reset and an empty string is returned. Resetting the inactivity time is forbidden in safe interpreters and will throw and error if tried.



126
127
128
129
130
131
132
 
# File 'lib/ffi-tk/command/tk_cmd.rb', line 126

def inactive(reset = None, window = None)
  if None == window
    Tk.execute(:tk, :inactive, reset)
  else
    Tk.execute(:tk, :inactive, '-displayof', window, reset)
  end
end

.scaling(number = None, window = None) ⇒ Object

Sets and queries the current scaling factor used by Tk to convert between physical units (for example, points, inches, or millimeters) and pixels. The number argument is a floating point number that specifies the number of pixels per point on window’s display. If the window argument is omitted, it defaults to the main window. If the number argument is omitted, the current value of the scaling factor is returned. A “point” is a unit of measurement equal to 1/72 inch. A scaling factor of 1.0 corresponds to 1 pixel per point, which is equivalent to a standard 72 dpi monitor. A scaling factor of 1.25 would mean 1.25 pixels per point, which is the setting for a 90 dpi monitor; setting the scaling factor to 1.25 on a 72 dpi monitor would cause everything in the application to be displayed 1.25 times as large as normal. The initial value for the scaling factor is set when the application starts, based on properties of the installed monitor, but it can be changed at any time. Measurements made after the scaling factor is changed will use the new scaling factor, but it is undefined whether existing widgets will resize themselves dynamically to accommodate the new scaling factor.



107
108
109
110
111
112
113
 
# File 'lib/ffi-tk/command/tk_cmd.rb', line 107

def scaling(number = None, window = None)
  if None == window
    Tk.execute(:tk, :scaling, number)
  else
    Tk.execute(:tk, :scaling, '-displayof', window, number)
  end
end

.useinputmethods(boolean = None, window = None) ⇒ Object

Sets and queries the state of whether Tk should use XIM (X Input Methods) for filtering events. The resulting state is returned. XIM is used in some locales (i.e., Japanese, Korean), to handle special input devices. This feature is only significant on X. If XIM support is not available, this will always return 0. If the window argument is omitted, it defaults to the main window. If the boolean argument is omitted, the current state is returned. This is turned on by default for the main display.



144
145
146
147
148
149
150
 
# File 'lib/ffi-tk/command/tk_cmd.rb', line 144

def useinputmethods(boolean = None, window = None)
  if None == window
    Tk.execute(:tk, :useinputmethods, boolean ? true : false)
  else
    Tk.execute(:tk, :useinputmethods, '-displayof', window, boolean ? true : false)
  end
end

.windowingsystem ⇒ Object 



152
153
154
 
# File 'lib/ffi-tk/command/tk_cmd.rb', line 152

def windowingsystem
  Tk.execute(:tk, :windowingsystem).to_sym
end

Instance Method Details

#tk_appname ⇒ Object

See Also:



5
6
7
 
# File 'lib/ffi-tk/command/tk_cmd.rb', line 5

def tk_appname
  TkCmd.appname(self)
end

#tk_appname=(new_name) ⇒ Object

See Also:



10
11
12
 
# File 'lib/ffi-tk/command/tk_cmd.rb', line 10

def tk_appname=(new_name)
  TkCmd.appname(self, new_name)
end

#tk_caret(options = None) ⇒ Object

See Also:



15
16
17
 
# File 'lib/ffi-tk/command/tk_cmd.rb', line 15

def tk_caret(options = None)
  TkCmd.caret(self, options)
end

#tk_inactive(reset = None) ⇒ Object

See Also:



30
31
32
 
# File 'lib/ffi-tk/command/tk_cmd.rb', line 30

def tk_inactive(reset = None)
  TkCmd.inactive(reset, self)
end

#tk_scaling ⇒ Object

See Also:



20
21
22
 
# File 'lib/ffi-tk/command/tk_cmd.rb', line 20

def tk_scaling
  TkCmd.scaling(None, self)
end

#tk_scaling=(number) ⇒ Object

See Also:



25
26
27
 
# File 'lib/ffi-tk/command/tk_cmd.rb', line 25

def tk_scaling=(number)
  TkCmd.scaling(number, self)
end

#tk_useinputmethods ⇒ Object

See Also:



35
36
37
 
# File 'lib/ffi-tk/command/tk_cmd.rb', line 35

def tk_useinputmethods
  TkCmd.useinputmethods(None, self)
end

#tk_useinputmethods=(boolean) ⇒ Object

See Also:



40
41
42
 
# File 'lib/ffi-tk/command/tk_cmd.rb', line 40

def tk_useinputmethods=(boolean)
  TkCmd.useinputmethods(boolean, self)
end

#tk_windowingsystem ⇒ Object 



44
45
46
 
# File 'lib/ffi-tk/command/tk_cmd.rb', line 44

def tk_windowingsystem
  TkCmd.windowingsystem
end