Documentation of tkmacosx

Button Widget

The tkmacosx Button widget is similar to default tkinter Button but supports all arguments of on a macos including some extra features.

• Argument:

  Modifies one or more widget options. If no options are given, the method returns a dictionary containing all current option values. All the options are pretty much the same as Tkinter Button. Here are the extra options of tkmacosx Button.

  • activebackground: Background color to use when the button is active. Give tuple of two colors for gradient effect in active background.
  • activeimage: Image to use when the button is active.
  • activebitmap: Bitmap to use when the button is active.
  • bordercolor: The color of the button border.
  • borderless: Blend the button with it's parent's background results in a clean look with no square borders. It will change color automatically.
  • disabledbackground: The color to use when the button is disabled.

• Usage:

  from tkinter import *
  from tkmacosx import Button
  
  root = Tk()
  
  B1 = Button(root, text='Mac OSX', bg='lightblue', fg='yellow', borderless=1)
  B1.pack()
  
  root.mainloop()

SFrame Widget

The tkmacosx SFrame widget is just like a tkinter Frame but vertically scrollable.

• Arguments:

  Modifies one or more widget options. If no options are given, the method returns a dictionary containing all current option values. All the options are pretty much the same as Tkinter Frame. Here are the extra options of tkmacosx SFrame.

  • scrollbarwidth: Set the width of scrollbar.
  • mousewheel: Set mousewheel scrolling.

• Usage:

  from tkinter import *
  from tkmacosx import SFrame
  
  root = Tk()
  frame = SFrame(root, bg='pink')
  frame.pack()
  
  for i in range(50):
     Button(frame, text='Button %s'%i).pack()
  
  root.mainloop()

Colorscale Widget

Colorscale is a new style color selector which is an alternate to tkinter's colorchooser.

• Arguments:

  • value: Get either 'RGB' or 'HEX'.
  • command: callback function with an argument.
  • orient: Set the orientation.
  • mousewheel: Set mousewheel to scroll the marker.
  • variable: Give tkinter variable (StringVar).
  • showinfo: Shows hex or rbg while selecting color.
  • showinfodelay: Delay before the show info disappears (in ms).

• Usage:

  from tkinter import *
  from tkmacosx import Colorscale
  
  root = Tk()
  CS = Colorscale(root, value='hex')
  CS.pack(side="bottom", padx=3, pady=3)
  
  root.mainloop()

Marquee Widget

Use Marquee for creating scrolling text which moves from right to left only if the text does not fit completely on the window.

• Arguments:

  • text: Give a string to display.
  • font: Font of the text.
  • fg: Set foreground color of the text.
  • fps: Set fps(frames per seconds).
  • left_margin: Set left margin to make text move further to right before reset.
  • initial_delay: Delay before text start to move. (in ms)
  • end_delay: Delay before text reset. (in ms)
  • smoothness: Set the smoothness of the animation.

• Usage:

  from tkinter import *
  from tkmacosx import Marquee
  
  root=Tk()
  marquee = Marquee(root, left_margin=20, initial_delay=2000, end_delay=2000,
                    text='This text will move from right to left if does not fit the window.')
  marquee.pack()
  
  root.mainloop()

ColorVar Variable

ColorVar of tkmacosx set same color to each widget it is assigned to. As ColorVar is a tkinter variable wrapper so it will change the color of widgets whenever the change is made to ColorVar instances. ColorVar takes HEX values and all the color names which tkinter supports but the get() method returns only the HEX value. It will work with all of the following keyword arguments of different widgets (eg:- Canvas, Frame, Button, Label, Canvas items, ...). 'fg', 'foreground', 'bg', 'background', 'activebackground', 'activeforeground', 'disabledforeground', 'highlightbackground', 'highlightcolor', 'selectforeground', 'readonlybackground', 'selectbackground', 'insertbackground', 'disabledbackground', 'activefill', 'activeoutline', 'disabledfill','disabledoutline', 'fill', 'outline', 'disabledbackground' (might work with more but have not tested).

• Usage:

  from tkinter import Tk, Label
  from tkmacosx import colors, ColorVar, Button
  
  root = Tk()
  root.geometry('100x100')
  
  color = ColorVar()
  color_list = list(colors.OrderedHex)
  L = Label(root, textvariable=color, bg=color)
  L.pack(fill='x', expand=1, padx=10, pady=10)
  B = Button(root, textvariable=color, bg=color)
  B.pack(fill='x', expand=1, padx=10, pady=10)
  
  def change_color(c=0):
     if c >= len(color_list): c=0
     color.set(color_list[c])
     root.after(70, change_color, c+1)
  
  change_color()
  root.mainloop()

DictVar Variable

DictVar of tkmacosx stores python dictionary. It is very similar to tkinter StringVar with few modifications to it. DictVar.get() returns an instance of dict type whereas StringVar returns str type also DictVar method get() is a bit different get(key=None, d=None) get a key from get() method if key=None it will return the complete dictionary.

• Usage:

  from tkinter import *
  from tkmacosx import DictVar
  
  root = Tk()
  dictionary = DictVar(value = {'width': 100, 'height': 200})
  
  print(type(dictionary.get()))
  print(dictionary.get())
  print(dictionary.get('width'))

SaveVar

SaveVar of tkmacosx will let you save and load values of tkinter variables (StringVar, IntVar, ..). SaveVar uses pickle module to save values of variables into a file and when the program is executed next time, it will load the same values as they were last time. If the content of the .py file changes, it might not load correct values to the assigned variables. To avoid this issue use name argument to refer to the exact assigned values later.

• Arguments:

  • var: Give the tkinter.Variable class like (tk.StringVar, tk.IntVar).
  • master: Parent widget.
  • value: Set value.
  • name: Set a name to group variables or to refer to assigned value when loaded.
  • filename: Set the name of the save file. (To make the file invisible in the directory start the name of the file with "." like ".cache-savevar")

• Usage:

  from tkinter import *
  from tkmacosx import SaveVar
  
  root = Tk()
  var1 = SaveVar(StringVar, root, 'Enter Username', 'Var1', '.cache-savevar')
  var2 = SaveVar(StringVar, root, 'Enter Password', 'Var2', '.cache-savevar')
  Entry(root, textvariable=var1).pack()
  Entry(root, textvariable=var2).pack()
  root.mainloop()

get_shade

Darken or Lighten a shade of color.

• Arguments:

  • color: Give a color as either HEX or name of the color.
  • shade: The amount of change required. Takes float. eg: shade=0.225.
  • mode: '-' for darker shade, '+' for lighter shade, 'auto-110' automatically decide lighter or darker. Where 110 is the intensity.

check_appearance

Checks DARK/LIGHT mode of macOS and returns boolean value. Other settings can also be checked with this function just by passing a different command line argument to check a particular setting to cmd parameter of check_appearance.

• Arguments:

  • cmd: Give commands. Like to check DARK/LIGHT mode the command is 'defaults read -g AppleInterfaceStyle'