Socket
Socket
Sign inDemoInstall

tkmacosx

Package Overview
Dependencies
1
Maintainers
1
Alerts
File Explorer

Install Socket

Detect and block malicious and high-risk dependencies

Install

tkmacosx

Tkmacosx is a Python library extension to the Tkinter module that let you change background color of the button on macOS.


Maintainers
1

Readme

tkmacosx

This module provides some modified widgets of Tkinter which fixes many issues with widgets not working properly on macOS platform. For example Button of tkmacosx which looks and feels exactly like a native Tkinter button can change its background and foreground color and has a lot more functionality, Issues with Radiobutton are also fixed with this library. The library also offers some more useful functionality.

Read more about all the classes and methods in the tkmacosx documentation.

Table of Contents

  1. Requirements
  2. Installation
  3. Demonstration
  4. Documentation
  5. Changelog
  6. License

Requirements

  • Python 3

Python packages:

  • tkinter (included in the python distribution)
  • colour

Installation

Use the package manager pip to install tkmacosx with the following command:

pip install tkmacosx

If you would like to get the latest master or branch from github, you could also:

pip install git+https://github.com/Saadmairaj/tkmacosx

Or even select a specific revision (branch/tag/commit):

pip install git+https://github.com/Saadmairaj/tkmacosx@master

Similarly, for tag specify tag with @v0.x.x. For example to download tag v0.1.0 from Git use:

pip install git+https://github.com/Saadmairaj/tkmacosx@v0.1.0

If you use Anaconda environment then you could run:

Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge

conda install -c saad_7 tkmacosx

Demonstration

python -m tkmacosx

Run the above command in the terminal or command line after installing tkmacosx to see working and almost all the configurable options of different widgets of tkmacosx.

Also if you want to style your button to stand out, scroll down to bottom of the window opened from the above command and randomise or configure button to different styles.

Documentation

Button Widget

The tkmacosx Button widget is alternative to tkinter's Button that supports all features on a macos that were not possible with tkinter Button like background, relief, overrelief, activebackground, and some other features can be set. There is a blue focus ring that tells if the button has the focus or not to disable or hide the focus ring, either set takefocus=0 or focuscolor=''.

  • Configurable options for a button widget. Syntax: Button(root, options=value, ...)

    OptionsDescription
    activebackgroundWhat background color to use when the button is active. The default is system specific. Give tuple of two colors for gradient effect in active background.
    activeforegroundWhat foreground color to use when the button is active. The default is system specific.
    activeimageWhat Image to display when the button is active. No image to display by default.

    Note: This option is exclusive to only this libraray, the option doesn't exist by default in tkinter.
    activebitmapWhat Bitmap to display when the button is active. No bitmap to display by default.

    Note: This option is exclusive to only this libraray, the option doesn't exist by default in tkinter.
    anchorWhere the text is positioned on the button. For example, anchor=tk.NE would position the text at the top right corner of the button.
    bordercolorThe color to use for the highlight border when the button does not have focus. The default is system-specific. Same as highlightbackground.
    borderlessBlend the button with its parent's background results in a clean look with no square borders. It will change color automatically. The default is False.

    Note: This option is exclusive to only this libraray, the option doesn't exist by default in tkinter.
    bd or borderwidthWidth of the border around the outside of the button. The default is two pixels.
    bg or backgroundNormal background color.
    commandFunction or method to be called when the button is clicked.
    cursorSelects the cursor to be shown when the mouse is over the button.
    disabledforegroundThe color to use when the button is disabled. The default is system specific.
    focuscolorThe color to use for the focus border when the button have focus. The default is system specific.

    Note: This option is exclusive to only this libraray, the option doesn't exist by default in tkinter.
    focusthicknessThe width of the focus border (pixels). The default is system specific.

    Note: This option is exclusive to only this libraray, the option doesn't exist by default in tkinter.
    fg or foregroundNormal foreground (text) color.
    fontText font to be used for the button's label.
    heightThe height of the button. The size is given in pixels for both text and images.
    highlightbackgroundColor of the focus highlight when the widget does not have focus.
    highlightcolorThe color of the focus highlight when the widget has focus.
    highlightthicknessThickness of the focus highlight.
    imageImage to be displayed on the button (instead of text).
    justifyHow to show multiple text lines: tk.LEFT to left-justify each line; tk.CENTER to center them; or tk.RIGHT to right-justify.
    overbackgroundAlternative background to use when the mouse is moved over the widget.

    Note: This option is exclusive to only this libraray, the option doesn't exist by default in tkinter.
    overforegroundAlternative foreground to use when the mouse is moved over the widget.

    Note: This option is exclusive to only this libraray, the option doesn't exist by default in tkinter.
    overreliefThe relief style to be used while the mouse is on the button; the default relief is tk.RAISED.
    padxAdditional padding left and right of the text.
    padyAdditional padding above and below the text.
    reliefSpecifies the relief type for the button. The default relief is tk.RAISED.
    repeatdelaySee repeatinterval, below.
    repeatintervalNormally, a button fires only once when the user releases the mouse button. If you want the button to fire at regular intervals as long as the mouse button is held down, set this option to a number of milliseconds to be used between repeats, and set the repeatdelay to the number of milliseconds to wait before starting to repeat. For example, if you specify “ repeatdelay=500, repeatinterval=100 ” the button will fire after half a second, and every tenth of a second thereafter, until the user releases the mouse button. If the user does not hold the mouse button down at least repeatdelay milliseconds, the button will fire normally.
    stateSet this option to "disabled" to gray out the button and make it unresponsive. Has the value "active" when the mouse is over it. Keep the button pressed with "pressed". Default is "normal".
    takefocusNormally, keyboard focus does visit buttons, and a space character acts as the same as a mouse click, “pushing” the button. You can set the takefocus option to zero to prevent focus from visiting the button.
    textText displayed on the button. Use internal newlines to display multiple text lines.
    textvariableAn instance of StringVar() that is associated with the text on this button. If the variable is changed, the new value will be displayed on the button.
    widthThe width of the button. The size is given in pixels for both text and images.
  • Methods on Button objects:

    MethodsDescription
    .invoke()Calls the button's command callback, and returns what that function returns. Has no effect if the button is disabled or there is no callback.
  • Example:

    from tkinter import Tk
    from tkmacosx import Button
    
    root = Tk()
    root.geometry('200x150')
    B0 = Button(root, text='Button')
    B0.pack(padx=20, pady=(20,0))
    B1 = Button(root, text='Button', bg='#ADEFD1',
                fg='#00203F', borderless=1)
    B1.pack(padx=20, pady=10)
    B2 = Button(root, text='Button', bg='#E69A8D',
                fg='#5F4B8B', borderless=1,
                activebackground=('#AE0E36', '#D32E5E'),
                activeforeground='#E69A8D')
    B2.pack()
    root.mainloop()
    

  • Few sample of different styles of button that can be configured.

# Options to get button in the first image.
b1 = Button(root, text='Button', activeforeground= '#EE3B3B', overrelief='flat', relief='flat', borderwidth=2,
    highlightthickness=1, font=font.Font(family='SignPainter', size=30, weight='bold', slant='roman'),
    focuscolor='#556B2F',highlightbackground='#CD5555', foreground='#1F1F1F', background='#7A7A7A',
    overbackground='#000000', overforeground='#00C78C', activebackground=('#BA55D3', '#D4D4D4'), borderless=1)

# Options to get button in the second image.
b2 = Button(root, text='Button', activeforeground= '#B5B5B5', overrelief='raised', relief='sunken', borderwidth=2,
    highlightthickness=4, font=font.Font(family='Brush Script MT', size=30, weight='bold', slant='roman'),
    focuscolor='#CD3700', highlightbackground='#AAAAAA', foreground='#6B6B6B', background='#BDBDBD',
    overbackground='#7A67EE', overforeground='#404040', activebackground=('#FF34B3', '#C1CDC1'), borderless=1)

# Options to get button in the third image.
b3 = Button(root, text='Button', activeforeground= '#FFDAB9', overrelief='flat', relief='raised', borderwidth=1,
    highlightthickness=3, font=font.Font(family='Helvetica', size=30, weight='bold', slant='roman', underline=1),
    focuscolor='#F5DEB3', highlightbackground='#8A360F',foreground='#FFC0CB', background='#708090',
    overbackground='#53868B', overforeground='#CCCCCC', activebackground=('#808069', '#C67171'), borderless=1)

CircleButton Widget

BETA-Disclaimer: Please note that this is a BETA version. Issues can be reported here.

Circle shaped tkinter Button can contain text or images, and you can associate a Python function or method with each button. There is a blue focus ring that tells if the button has the focus or not to disable or hide the focus ring, either set takefocus=0 or focuscolor=''. The CircleButton widget supports all the configurable options of tkmacosx Button.

  • Configurable options for a button widget. Syntax: CircleButton(root, options=value, ...) All the options are pretty much the same as tkmacosx Button. Other options:

    OptionsDescription
    radiusSet the size of the button using radius (in pixels). If width or height are given then radius value gets cancelled out.
  • Methods on CircleButton objects:

    MethodsDescription
    .invoke()Calls the button's command callback, and returns what that function returns. Has no effect if the button is disabled or there is no callback.
  • Example:

from tkinter import *
from tkmacosx import CircleButton

root = Tk()
B0 = CircleButton(root, text='Button')
B0.grid(row=0)
B1 = CircleButton(root, text='Button', bg='#ADEFD1',
            fg='#00203F', borderless=1)
B1.grid(row=0, column=1)
B2 = CircleButton(root, text='Button', bg='#E69A8D',
            fg='#5F4B8B', borderless=1,
            activebackground=('#AE0E36', '#D32E5E'),
            activeforeground='#E69A8D')
B2.grid(row=0, column=2)
root.mainloop()


SFrame Widget

The tkmacosx SFrame widget is just like a tkinter Frame but can be vertically scrolled. The SFrame supports intelligent mousewheel scrolling where it let you use mousewheel with other children widgets also having mousewheel scrolling without interfering with other widgets scrolling, a list of widgets having mousewheel scrolling can be passed to avoidmousewheel argument (ex: avoidmousewheel=(text1, text2, sframe) or just one avoidmousewheel=text2).

  • Configurable options for a sframe widget. Syntax: SFrame(root, options=value, ...)

    OptionsDescription
    avoidmousewheelGive widgets that also having the mousewheel scrolling and is a child of SFrame, this option will configure widgets to support their mousewheel scrolling as well and not interfere with SFrame mousewheel scrolling. For example: Text widget inside SFrame can have mousewheel scrolling as well as SFrame.
    autohidescrollbarAuto hides the scrollbar when not in use or when the cursor is not around the scrollbar location. The scrollbar will reappear when mousewheel scrolling is used or the cursor is moved over the scrollbar location. Default is False.
    autohidescrollbardelayTime taken for the scrollbar to hide after reappearing.
    bg or backgroundThe frame's background color.
    bd or borderwidthWidth of the frame's border. The default is 0 (no border).
    cursorThe cursor used when the mouse is within the frame widget.
    heightThe vertical dimension of the new frame. This will be ignored unless you also call .grid_propagate(0) on the frame.
    highlightbackgroundColor of the focus highlight when the frame does not have focus.
    highlightcolorColor is shown in the focus highlight when the frame has the focus.
    highlightthicknessThe thickness of the focus highlight.
    mousewheelSet mousewheel scrolling. The default is False
    padxNormally, a Frame fits tightly around its contents. To add N pixels of horizontal space inside the frame, set padx=N.
    padyUsed to add vertical space inside a frame. See padx above.
    reliefThe default relief for a frame is tk.FLAT, which means the frame will blend in with its surroundings. To put a border around a frame, set its borderwidth to a positive value and set its relief to one of the standard relief types.
    scrollbarwidthSet the width of scrollbar.
    takefocusNormally, frame widgets are not visited by input focus. However, you can set takefocus=1 if you want the frame to receive keyboard input. To handle such input, you will need to create bindings for keyboard events.
    widthThe horizontal dimension of the new frame. This value be ignored unless you also call .grid_propagate(0) on the frame
  • Example:

    from tkinter import *
    from tkmacosx import SFrame, Button
    
    root = Tk()
    root.geometry('350x300')
    frame = SFrame(root, bg='#333')
    text = Text(frame, background='#5F4B8B',
                width=35, height=10, foreground='white')
    text.pack(pady=(0,20))
    
    frame2 = SFrame(frame, bg='#E69A8D', scrollbarwidth=3)
    frame2.pack(pady=20)
    
    frame.config(avoidmousewheel=(text, frame2))
    frame.pack(expand=1, fill='both')
    for i in range(50):
       Button(frame2, text='Button %s'%i).pack()
       text.insert('end', 'Text Line: %s\n'%i)
    
    root.mainloop()
    


Colorscale Widget

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

  • Configurable options for a Colorscale widget. Syntax: Colorscale(root, options=value, ...)

    OptionsDescription
    bd or borderwidthWidth of the border around the outside of the Colorscale. The default is two pixels.
    commandA function or method with a parameter that is called when the slider is moved or scrolled and an argument is paased to the callback. The callback can be a function, bound method, or any other callable Python object. If this option is not used, nothing will happen when the slider is moved.
    cursorCursor used in the Colorscale.
    gradientTakes tuple of two colors. Two colors are required to form a gradient (sequence[FROM, TO], For example: A tuple of tuple('white', 'black') will create a Colorscale from WHITE to BLACK color). By default is complete color gradient.
    heightSize of the Colorscale in the Y dimension.
    highlightbackgroundColor of the focus highlight when the widget does not have focus.
    highlightcolorColor is shown in the focus highlight.
    highlightthicknessThe thickness of the focus highlight. The default value is 1.
    mousewheelMove the slider with mousewheel with True. By default the option is set False.
    orientSet the orientation (VERTICAL, HORIZONTAL). By default is VERTICAL.
    reliefThe relief style of the Colorscale. Default is tk.FLAT.
    showinfoShows hex or rbg while selecting color.
    showinfodelayDelay before the show info disappears (in ms).
    takefocusNormally, focus will cycle through this widget with the tab key only if there are keyboard bindings set for it (see Section 54, “Events”for an overview of keyboard bindings). If you set this option to 1, the focus will always visit this widget. Set it to '' to get the default behavior.
    valueGet either 'RGB' or 'HEX'. By deafult is hex.
    variableAssociates a Tkinter variable (usually a tk.StringVar, tkm.ColorVar). If the slider is moved the value of the variable changes as well.
    widthSize of the Colorscale in the X dimension.
  • Example:

    from tkinter import *
    from tkmacosx import Colorscale, ColorVar
    
    root = Tk()
    root['bg'] = '#333'
    bgvar = ColorVar(value='#333')
    fgvar = ColorVar(value='white')
    Label(root, text="I am a Label, Hello! :-)",bg=bgvar, fg=fgvar).pack(pady=10)
    Colorscale(root, value='hex', variable=bgvar, mousewheel=1).pack(padx=20)
    Colorscale(root, value='hex', variable=bgvar, mousewheel=1,
            gradient=('pink', 'purple')).pack(pady=10)
    Colorscale(root, value='hex', variable=fgvar, mousewheel=1,
            gradient=('lightgreen', 'orange')).pack()
    Colorscale(root, value='hex', variable=fgvar, mousewheel=1,
            gradient=('white', '#89ABE3')).pack(pady=10)
    
    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.

  • Configurable options for a Marquee widget. Syntax: Marquee(root, options=value, ...)

    OptionsDescription
    bg or backgroundThe background color of the marquee area.
    bd or borderwidthWidth of the border around the marquee. The default value is two pixels.
    cursorCursor that appears when the mouse is over this marquee.
    disabledforegroundThe color to use when the button is disabled. The default is systemspecific.
    end_delayTime to wait before reseting at the end of movement. Default is 1000 ms.
    fontIf you are displaying text in this marquee with the text option, the font option specifies in what font that text will be displayed.
    fg or foregroundIf you are displaying text in this marquee, this option specifies the color of the text.
    fpsSet fps(frames per seconds) indirectly is the speed of text movement. Default is 30.
    heightThe height of the Marquee is in pixels. If this option is not set, the Marquee will be sized to fit its contents.
    highlightbackgroundColor of the focus highlight when the widget does not have focus.
    highlightcolorThe color of the focus highlight when the widget has focus.
    highlightthicknessThe thickness of the focus highlight.
    initial_delayTime to wait before starting the movement of the text. Default is 1000 ms.
    justifySpecifies how multiple lines of text will be aligned with respect to each other: tk.LEFT for flush left, tk.CENTER for centered (the default), or tk.RIGHT for right-justified.
    left_marginText to keep moving to right after last character is displayed before reseting.
    smoothnessMillisecond delay in movement of each frame. Default is 1 ms.
    stateBy default, a Marquee widget is in the tk.NORMAL state. Set this option to tk.DISABLED to make it unresponsive to mouse events.
    reliefSpecifies the appearance of a decorative border around the Marquee. The default is tk.FLAT; for other values.
    takefocusNormally, focus does not cycle through Marquee widgets. If you want this widget to be visited by the focus, set takefocus=1.
    textTo display one or more lines of text in a Marquee widget, set this option to a string containing the text. Internal newlines ('\n') will force a line break.
    widthThe width of the Marquee is in pixels. If this option is not set, the Marquee will be sized to fit its contents.
  • Methods on Marquee widget objects:

    MethodsDescription
    .reset()Resets the position of the text to default.
    .stop(reset: bool)Stops the moving text to the current position. Set parameter reset=True to stop the movement and reset the position of the text to default.
    .play(reset: bool)Plays the stopped text from the current position. Set parameter reset=True to play from the default position.
  • Example:

    from tkinter import *
    from tkmacosx import Marquee
    
    text1 = """This text will move from right to left \
    if does not fit the window."""
    text2 = """Please hover over the text to move it. \
    This text will move only if the cursor hovers over \
    the text widget."""
    
    root = Tk()
    root['bg'] = '#333'
    Marquee(root, bg='#FEE715', fg='#101820', text=text1).pack(pady=10)
    m = Marquee(root, fg='#FEE715', bg='#101820', text=text2)
    m.pack(pady=(0,10), padx=10)
    m.stop(True)
    m.bind('<Enter>', lambda _: m.play())
    m.bind('<Leave>', lambda _: m.stop())
    root.mainloop()
    


Radiobutton Widget

Radiobutton of tkmacosx are fixed from multiple issues i.e. background color not showing properly when indicator=0, activebackground, activeforeground options not working, few other issues are fixed in tkmacosx Radiobutton. Radiobuttons are sets of related widgets that allow the user to select only one of a set of choices. Each radiobutton consists of two parts, the indicator and the label.

  • Configurable options for a Colorscale widget. Syntax: Radiobutton(root, options=value, ...)

    OptionsDescription
    activebackgroundThe background color when the mouse is over the radiobutton.
    activeforegroundThe foreground color when the mouse is over the radiobutton.
    anchorIf the widget inhabits a space larger than it needs, this option specifies where the radiobutton will sit in that space. The default is anchor=tk.CENTER. For other positioning options. For example, if you set anchor=tk.NE, the radiobutton will be placed in the top right corner of the available space.
    bg or backgroundThe normal background color behind the indicator and label.
    bitmapTo display a monochrome image on a radiobutton, set this option to a bitmap.
    bd or borderwidthThe size of the border around the indicator part itself. Default is two pixels.
    commandA procedure to be called every time the user changes the state of this radiobutton.
    compoundIf you specify both text and a graphic (either a bitmap or an image), this option specifies where the graphic appears relative to the text. Possible values are tk.NONE (the default value), tk.TOP, tk.BOTTOM, tk.LEFT, tk.RIGHT, and tk.CENTER. For example, compound=tk.BOTTOM would position the graphic below the text. If you specify compound=tk.NONE, the graphic is displayed but the text (if any) is not.
    cursorIf you set this option to a cursor name, the mouse cursor will change to that pattern when it is over the radiobutton.
    disabledforegroundThe foreground color used to render the text of a disabled radiobutton. The default is a stippled version of the default foreground color.
    fontThe font used for the text.
    fg or foregroundThe color used to render the text.
    heightThe number of lines (not pixels) of text on the radiobutton. Default is 1.
    highlightbackgroundThe color of the focus highlight when the radiobutton does not have focus.
    highlightcolorThe color of the focus highlight when the radiobutton has the focus.
    highlightthicknessThe thickness of the focus highlight. Default is 1. Set highlightthickness=0 to suppress the display of the focus highlight.
    imageTo display a graphic image instead of text for this radiobutton, set this option to an image object. The image appears when the radiobutton is not selected; compare selectimage, below.
    inidicatoronNormally a radiobutton displays its indicator. If you set this option to zero, the indicator disappears, and the entire widget becomes a “push-push” button that looks raised when it is cleared and sunken when it is set. You may want to increase the borderwidth value to make it easier to see the state of such a control.
    justifyIf the text contains multiple lines, this option controls how the text is justified: tk.CENTER (the default), tk.LEFT, or tk.RIGHT.
    offreliefIf you suppress the indicator by asserting indicatoron=False, the offrelief option specifies the relief style to be displayed when the radiobutton is not selected. The default values is tk.RAISED.
    overreliefSpecifies the relief style to be displayed when the mouse is over the radiobutton.
    padxHow much space to leave to the left and right of the radiobutton and text. Default is 1.
    padyHow much space to leave above and below the radiobutton and text. Default is 1.
    reliefBy default, a radiobutton will have tk.FLAT relief, so it doesn't stand out from its background. You can also use relief=tk.SOLID, which displays a solid black frame around the radiobutton.
    selectcolorThe color of the radiobutton when it is set. Default is red.
    selectimageIf you are using the image option to display a graphic instead of text when the radiobutton is cleared, you can set the selectimage option to a different image that will be displayed when the radiobutton is set.
    stateThe default is state=tk.NORMAL, but you can set state=tk.DISABLED to gray out the control and make it unresponsive. If the cursor is currently over the radiobutton, the state is tk.ACTIVE.
    takefocusBy default, the input focus will pass through a radiobutton. If you set takefocus=0, focus will not visit this radiobutton.
    textThe label displayed next to the radiobutton. Use newlines ('\n') to display multiple lines of text.
    textvariableIf you need to change the label on a radiobutton during execution, create a StringVar to manage the current value, and set this option to that control variable. Whenever the control variable's value changes, the radiobutton's annotation will automatically change to that text as well.
    underlineWith the default value of -1, none of the characters of the text label are underlined. Set this option to the index of a character in the text (counting from zero) to underline that character.
    valueWhen a radiobutton is turned on by the user, its control variable is set to its current valueoption. If the control variable is an IntVar, give each radiobutton in the group a different integer value option. If the control variable is a StringVar, give each radiobutton a different string value option.
    variableThe control variable that this radiobutton shares with the other radiobuttons in the group. This can be either an IntVar or a StringVar.
    widthThe default width of a radiobutton is determined by the size of the displayed image or text. You can set this option to a number of characters ( not pixels) and the radiobutton will always have room for that many characters.
    wraplengthNormally, lines are not wrapped. You can set this option to a number of characters and all lines will be broken into pieces no longer than that number.
  • Methods on Radiobutton widget objects:

    MethodsDescription
    .deselect()Clears (turns off) the radiobutton.
    .flash()Flashes the radiobutton a few times between its active and normal colors, but leaves it the way it started.
    .invoke()You can call this method to get the same actions that would occur if the user clicked on the radiobutton to change its state.
    .select()Sets (turns on) the radiobutton.
  • Example:

    import tkinter as tk
    import tkmacosx as tkm
    
    root = tk.Tk()
    var = tk.IntVar()
    
    r1 = tkm.Radiobutton(root, text='Radiobutton1', value=1,
                         variable=var, indicatoron=0, padx=20)
    r2 = tkm.Radiobutton(root, text='Radiobutton2', value=2,
                         variable=var, indicatoron=0, padx=20)
    r3 = tkm.Radiobutton(root, text='Radiobutton3', value=3,
                         variable=var, indicatoron=0, padx=20)
    
    r1.pack(pady=10)
    r2.pack(padx=10)
    r3.pack(pady=10)
    
    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' (might work with more but have not tested).

  • Configurable options for a ColorVar variable. Syntax: ColorVar(root, options=value, ...)

    OptionsDescription
    valueThe value is an optional value (defaults to "").
    nameThe name is an optional Tcl name (defaults to PYVARnum). If _name matches an existing variable and value is omitted then the existing value is retained.
  • Methods on ColorVar variable objects:

    MethodsDescription
    .get()Returns the current value of the variable.
    .set(value: str)Changes the current value of the variable. If any widget options are slaved to this variable, those widgets will be updated when the main loop next idles.
  • Example:

    from tkinter import Tk, Label
    from tkmacosx import ColorVar, Button, gradient
    
    root = Tk()
    root['bg'] = '#333'
    root.geometry('200x200')
    
    def change_color(c=0):
       if c >= len(color_list): c=0
       color.set(color_list[c])
       root.after(50, change_color, c+1)
    
    color = ColorVar()
    color_list = gradient(200)
    L = Label(root, textvariable=color, bg='#333', fg=color)
    L.pack(fill='x', expand=1, padx=10, pady=10)
    B = Button(root, textvariable=color, bg=color, borderless=1, activeforeground=color)
    B.pack(fill='x', expand=1, padx=10, pady=10)
    
    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.

  • Configurable options for a DictVar variable. Syntax: DictVar(root, options=value, ...)

    OptionsDescription
    valueThe value is an optional value (defaults to {}).
    nameThe name is an optional Tcl name (defaults to PYVARnum). If _name matches an existing variable and value is omitted then the existing value is retained.
  • Methods on DictVar variable objects:

    MethodsDescription
    .get(key: any=None, d: any=None)Returns the current value of the variable. To get a specific value of dictionary use key, give a default value to d if the key is not available.
    set(value: str)Changes the current value of the variable. If any widget options are slaved to this variable, those widgets will be updated when the main loop next idles.
  • Example:

    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.

  • Configurable options for a SaveVar function. Syntax: SaveVar(var, master=None, value=None, name=None, filename='data.pkl')

    ParametersDescription
    varGive the tkinter.Variable class like (tk.StringVar, tk.IntVar)
    masterParent widget.
    valueThe value is an optional value (Given variable's default value).
    nameSet a name to group variables or to refer to assigned value when loaded.
    filenameSet the name of the save file. (To make the file invisible in the directory start the name of the file with "." like ".cache-savevar")
  • Example:

    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

  • Configurable options for a get_shade function. Syntax: get_shade(color, shade, mode='auto')

    ParametersDescription
    colorGive a color as either HEX or name of the color.
    shadeThe amount of change required. Takes float between 0.0 to 1.0 eg: shade=0.225.
    modeUse mode for more control over the shade of the color. Use mode='-' for darker shade, use mode='+' for lighter shade, use mode='auto' to automatically decide the shade (the deafult). To change the intensity of shade checking use mode='auto-110 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.

  • Configurable options for a check_appearance function. Syntax: check_appearance(cmd='defaults read -g AppleInterfaceStyle').

    ParametersDescription
    cmdGive commands. For example: To check DARK/LIGHT mode the command is 'defaults read -g AppleInterfaceStyle'.

check_light_dark

Tells if the given RGB or HEX code is lighter or darker shade of color. Returns "black" for darker shade and "white" for lighter shade.

  • Configurable options for a check_light_dark function. Syntax: check_light_dark(value, intensity=110).

    ParametersDescription
    valueGive sequence of RBG values or hexcode.
    intensityThe measurable amount of a brightness. By deafult it is 110.

gradient

This function returns sequences of rainbow colors hexcodes in order.

  • Configurable options for a gradient function. Syntax: gradient(iteration).

    ParametersDescription
    iterationLength of the sequences.

Changelog

  • v1.0.5

    • Fix Button disabled state (#39)
    • Improved focus out appearance (#39)
  • v1.0.4

    • Fix button with image disappear on setting size (#37)
    • Fix spacebar invoke on Button not working (#32)
  • v1.0.3

    • Fix Button face color and foreground color.
    • Fix Button border line color changing to black when swtiching from dark to light mode.
    • Fix washed out background color of button when window is not in focus (#28)
    • Remove adapting highlightbackground for consistency (#27)
    • Increase button border intensity by 0.15
    • Minor improvements to the overall appearance of the button.
  • v1.0.2

    • Fix unknown color name "systemWindowBackgroundColor" (#20)
    • Partial "borderless" button option support for ttk widgets (#19)
    • Exclude test package in setup.py
  • v1.0.1

    • Fix widgets not auto-switch light/dark mode. (#18)
    • Fix Button not working with ttk widgets. (#19)
  • v1.0.0

    • Add Tests.
    • Add "-selectcolor" option to ColorVar list.
    • Reorganise tkmacosx package files into multiple packages.
    • Reorganise button items to a separate class.
    • Fix Misc._configure() returning 'NoneType'. (#12)
    • Fix text misalignment when changed dynamically under certain situations.
    • Fix -activebackground" not accepting mac deafult system colors names.
    • Fix button appearance when toplevel is out of focus.
    • Fix focusthickness=0 glitch of button.
    • Fix ColorVar not working with -focuscolor of button.
    • Fix unknown option "-bitmap". error
    • Fix "-width", "-height" have effect on 0 value.
    • Fix Marquee cget() issues.
    • Fix "-activebackground" not changing with Variable.
    • Fix ColorVar not working with few Button options.
    • Fix lag when Button is configured.
    • Fix an error with Button.destroy(). (#17)
  • v0.1.6

    • Add new feature, set image as background in Button widget.
    • Add new functions (hex_to_rgb, check_light_dark).
    • Add XView to Marquee widget.
    • Add Radiobutton widget and fix selectcolor issue. (#11)
    • Reorganize properties of BaseButton class.
    • Fix broken links.
    • Fix anchor of Button widget. (#7)
    • Fix focusring appearing for all CircleButton.
    • Fix activebackground and activeforeground of Radiobutton.
    • Remove colors.py file
    • Remove support for python 2.x.
    • Remove unnecessary code from multiple files.
    • Remove Information.md file.
    • Remove tkmacosx/README.md file.
  • v0.1.5

    • Add new CircleButton Widget widget.
    • Fix ["key"] to [key] in Marquee.
    • Fix Colorvar not working with item of canvas in 0.1.4.
    • Fix Marquee.play(reset=True) to reset and play the text from beginning.
    • Fix focusthickness of button not working when set to 1.
    • Fix Image not showing when button is active.
    • Fix Text/Image/Bitmap bleed off the button widget.
    • Fix width or height of button widget not working with compound argument.
  • v0.1.4

    • Add new feature "gradient" to Colorscale widget.
    • Add new features to Button widget.
    • Add new stop, play and reset methods to Marquee.
    • Add new feature avoidmousewheel to SFrame.
    • Fix height not working with Button widget issue.
    • Fix foreground argument not working in Button widget.
    • Fix SFrame not autosizing according to widgets.
    • Redesign classes of widgets.
    • Remove large images.
    • Remove numpy and PIL dependencies.
    • Some other fixes and improvements.
  • v0.1.3

    • Fix can't invoke "bindtags" command error. (#3)
  • v0.1.2

    • Add python 2.x support.
    • Fix half HEX issues. (#6)
  • v0.1.1

    • Add Marquee widget.
    • ColorVar now works with Canvas items as well.
    • Fix ColorVar not working with the foreground of tkmacosx.Button.
    • Fix unnecessary focus_set() by tkmacosx.Button.
    • Fix issues with main.py file.
    • Fix issues with SaveVar().
  • v0.1.0

    • Add SaveVar() function to save and load tkinter variable.
    • Fix colors import issue.
  • v0.0.9

    • Fix installation issues.
  • v0.0.8

    • Fix installation issues.
  • v0.0.7

    • Change eval() with ast.literal_eval() in DictVar Variable
    • Fix colorscale issues.
  • v0.0.6

    • Add new style tkinter colorscale.
  • v0.0.5

    • Fix a bug where borderless for multiple buttons does not work properly.
    • Improve init.py file.
  • v0.0.4

    • Fix an import error.
  • v0.0.3

    • Add docstring.
  • v0.0.2

    • Fix an error running command python -m tkmacosx.
  • v0.0.1

    • Initial release.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method of this repository before making a change.

Please make sure to update tests as appropriate.

License

Apache

FOSSA Status

Keywords

FAQs


Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc