Skip to main content

A package that creates and manipulates screen overlays based on tkinter.

Project description

Overlay

A package that creates and manipulates screen overlays based on tkinter.

Platforms

  • Mac OS (tested and works)
  • Linux (not tested)
  • Windows (tested and does not work)

Installation

pip install overlay

Usage

A basic overlay is created as such:

from overlay import Window

win = Window()
Window.launch()

The constructor of the Window class takes the following (optional) parameters:

  • size: tuple, the dimension (width, height) of the overlay window.
  • position: tuple, the position of the overlay (on screen).
  • transparent: bool, whether to set the overlay background transparent.
  • alpha: float [0, 1], the alpha (transparency) of the overlay.
  • draggable: bool, whether the window can be dragged

Note that the parameters mentioned above can be edited any time as attributes of an instance of Window.

In order to edit the content of a overlay, one needs to obtain the root of the overlay, upon which all else shall be build.

import tkinter as tk
from overlay import Window

win = Window()
label = tk.Label(win.root, text="Window_0")
label.pack()
Window.launch()

Multiple overlays can be created just as easily:

import tkinter as tk
from overlay import Window

win_0 = Window()
label_0 = tk.Label(win_0.root, text="Window_0")
label_0.pack()
win_1 = Window()
label_1 = tk.Label(win_1.root, text="Window_1")
label_1.pack()
Window.launch()

The following program covers a brief explaination on other methods of the Window class.

import tkinter as tk
from time import sleep
from overlay import Window

def other_stuff(text):
	'''A simple demonstration. The usage of sleep is to emphasize the effects of each action.'''
	print(text)
	sleep(2)
	win_0.hide() # Hides the overlay.
	sleep(1)
	win_0.show() # Shows the overlay.
	sleep(1)
	win_0.focus() # Sets focus to overlay.
	win_1.center() # Moves the overlay to the center of the screen.
	sleep(1)
	Window.hide_all() # Hides all overlays.
	sleep(1)
	Window.show_all() # Shows all overlays.
	sleep(1)
	win_0.destroy() # Kills the overlay.
	sleep(1)
	Window.destroy_all() # Kills all overlays and ends the mainloop.


'''Creates two windows.'''
win_0 = Window()
label_0 = tk.Label(win_0.root, text="Window_0")
label_0.pack()
win_1 = Window()
label_1 = tk.Label(win_1.root, text="Window_1")
label_1.pack()

Window.after(2000, other_stuff, 'Hello World') # Identical to the after method of tkinter.Tk.

Window.launch()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for overlay, version 1.1.5
Filename, size File type Python version Upload date Hashes
Filename, size overlay-1.1.5-py3-none-any.whl (12.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size overlay-1.1.5.tar.gz (11.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page