Restructuration + init test system
This commit is contained in:
145
webpicdownloader/view/HomeView.py
Normal file
145
webpicdownloader/view/HomeView.py
Normal file
@@ -0,0 +1,145 @@
|
||||
import tkinter as tk
|
||||
import tkinter.font as tfont
|
||||
from tkinter import ttk
|
||||
from tkinter import scrolledtext as tst
|
||||
from webpicdownloader.controller.HomeController import HomeController
|
||||
from webpicdownloader.view.MainWindow import MainWindow
|
||||
|
||||
|
||||
class HomeView(ttk.Frame):
|
||||
"""
|
||||
View - HomeWindow
|
||||
|
||||
This view allows you to start the scraping/downloading process,
|
||||
as well as to display the progress of the process.
|
||||
|
||||
@author Jérémi Nihart / EndMove
|
||||
@link https://git.endmove.eu/EndMove/WebPicDownloader
|
||||
@version 1.0.1
|
||||
@since 2022-09-05
|
||||
"""
|
||||
# Variables
|
||||
__controller: HomeController = None
|
||||
|
||||
# Constructor
|
||||
def __init__(self, parent: MainWindow, controller: HomeController):
|
||||
"""
|
||||
Constructor
|
||||
|
||||
* :parent: -> The main windows container.
|
||||
* :controller: -> The view controller
|
||||
"""
|
||||
super().__init__(parent)
|
||||
|
||||
# Init view
|
||||
self.__init_content()
|
||||
|
||||
# Save and setup controller
|
||||
self.__controller = controller
|
||||
controller.set_view(self)
|
||||
|
||||
# START Internal functions
|
||||
def __init_content(self) -> None:
|
||||
"""
|
||||
[internal function]
|
||||
=> Initialize the view content.
|
||||
"""
|
||||
self.columnconfigure(0, weight=1)
|
||||
self.columnconfigure(1, weight=3)
|
||||
|
||||
# Website link
|
||||
self.web_label = ttk.Label(self, text="Website URL:")
|
||||
self.web_label.grid(row=0, column=0, sticky=tk.W, padx=5, pady=5)
|
||||
self.web_entry = ttk.Entry(self, width=50) # show="-"
|
||||
self.web_entry.grid(row=0, column=1, sticky=tk.E, padx=5, pady=5, ipadx=2, ipady=2)
|
||||
|
||||
# Download name
|
||||
self.name_label = ttk.Label(self, text="Download Name:")
|
||||
self.name_label.grid(row=1, column=0, sticky=tk.W, padx=5, pady=5)
|
||||
self.name_entry = ttk.Entry(self, width=50)
|
||||
self.name_entry.grid(row=1, column=1, sticky=tk.E, padx=5, pady=5, ipadx=2, ipady=2)
|
||||
|
||||
# Logs area
|
||||
log_textarea_font = tfont.Font(size=10)
|
||||
self.log_textarea = tst.ScrolledText(self, font=log_textarea_font, wrap=tk.WORD, state=tk.DISABLED, width=40, height=8)#, font=("Times New Roman", 15))
|
||||
self.log_textarea.grid(row=3, column=0, columnspan=2, sticky=tk.EW, pady=10, padx=10)
|
||||
|
||||
# Message state
|
||||
self.message_label = ttk.Label(self, text='message label')
|
||||
|
||||
# Download button
|
||||
self.download_button = ttk.Button(self, text="Start downloading", command=self.__event_button_download)
|
||||
self.download_button.grid(row=5, column=1, sticky=tk.E, padx=5, pady=5, ipadx=5, ipady=2)
|
||||
|
||||
def __event_button_download(self) -> None:
|
||||
"""
|
||||
[internal function]
|
||||
=> Function called when a download is requested.
|
||||
"""
|
||||
self.__controller.on_download_requested(self.web_entry.get(), self.name_entry.get())
|
||||
# END Internal functions
|
||||
|
||||
# START Controller methods
|
||||
def add_log(self, line: str) -> None:
|
||||
"""
|
||||
[function for controller]
|
||||
=> Add a log in the textarea where the logs are displayed.
|
||||
|
||||
* :line: -> Log message to add.
|
||||
"""
|
||||
self.log_textarea.configure(state=tk.NORMAL)
|
||||
self.log_textarea.insert(tk.END, f"~ {line}\n")
|
||||
self.log_textarea.see(tk.END)
|
||||
self.log_textarea.configure(state=tk.DISABLED)
|
||||
|
||||
def clear_logs(self) -> None:
|
||||
"""
|
||||
[function for controller]
|
||||
=> Clean the textarea where the logs are displayed.
|
||||
"""
|
||||
self.log_textarea.configure(state=tk.NORMAL)
|
||||
self.log_textarea.delete('1.0', tk.END)
|
||||
self.log_textarea.configure(state=tk.DISABLED)
|
||||
|
||||
def show_error_message(self, message) -> None:
|
||||
"""
|
||||
[function for controller]
|
||||
=> Display an error message on the interface.
|
||||
|
||||
* :message: -> Message to display.
|
||||
"""
|
||||
self.message_label.configure(text=message, foreground='red')
|
||||
self.message_label.grid(row=4, column=0, columnspan=2, sticky=tk.NS, padx=2, pady=2)
|
||||
self.message_label.after(25000, self.hide_message)
|
||||
|
||||
def show_success_message(self, message) -> None:
|
||||
"""
|
||||
[function for controller]
|
||||
=> Display a success message on the interface.
|
||||
|
||||
* :message: -> Message to display.
|
||||
"""
|
||||
self.message_label.configure(text=message, foreground='green')
|
||||
self.message_label.grid(row=4, column=0, columnspan=2, sticky=tk.NS, padx=2, pady=2)
|
||||
self.message_label.after(25000, self.hide_message)
|
||||
|
||||
def hide_message(self) -> None:
|
||||
"""
|
||||
[function for controller and this view]
|
||||
=> Hide the message on the interface.
|
||||
"""
|
||||
self.message_label.grid_forget()
|
||||
|
||||
def set_interface_state(self, disable: bool) -> None:
|
||||
"""
|
||||
[function for controller]
|
||||
=> Allows to change the status of the interface with which the user
|
||||
interacts by activating/deactivating it.
|
||||
|
||||
* :disabled: -> True: interface disabled, False: interface enabled.
|
||||
"""
|
||||
state = tk.DISABLED if disable else tk.NORMAL
|
||||
self.web_entry['state'] = state
|
||||
self.name_entry['state'] = state
|
||||
self.download_button['state'] = state
|
||||
# END Controller methods
|
||||
101
webpicdownloader/view/InfoView.py
Normal file
101
webpicdownloader/view/InfoView.py
Normal file
@@ -0,0 +1,101 @@
|
||||
import tkinter as tk
|
||||
from tkinter import font
|
||||
from tkinter import ttk
|
||||
from webpicdownloader.controller.Frames import Frames
|
||||
from webpicdownloader.controller.InfoController import InfoController
|
||||
from webpicdownloader.view.MainWindow import MainWindow
|
||||
|
||||
|
||||
class InfoView(ttk.Frame):
|
||||
"""
|
||||
View - InfoWindow
|
||||
|
||||
This view displays information about the program, as well as its version and release date.
|
||||
|
||||
@author Jérémi Nihart / EndMove
|
||||
@link https://git.endmove.eu/EndMove/WebPicDownloader
|
||||
@version 1.0.0
|
||||
@since 2022-09-06
|
||||
"""
|
||||
# Variables
|
||||
__controller: InfoController = None
|
||||
|
||||
# Constructor
|
||||
def __init__(self, parent: MainWindow, controller: InfoController):
|
||||
"""
|
||||
Constructor
|
||||
|
||||
* :parent: -> The main windows container.
|
||||
* :controller: -> The view controller
|
||||
"""
|
||||
super().__init__(parent)
|
||||
|
||||
# Init view
|
||||
self.__init_content()
|
||||
|
||||
# Save and setup controller
|
||||
self.__controller = controller
|
||||
controller.set_view(self)
|
||||
|
||||
# START Internal functions
|
||||
def __init_content(self) -> None:
|
||||
"""
|
||||
[internal function]
|
||||
=> Initialize the view content.
|
||||
"""
|
||||
self.columnconfigure(0, weight=4)
|
||||
|
||||
# Back button
|
||||
self.back_button = ttk.Button(self, text="Back", command=self.__event_button_back)
|
||||
self.back_button.grid(row=0, column=0, sticky=tk.E, padx=5, pady=5, ipadx=1, ipady=1)
|
||||
|
||||
# About title
|
||||
self.title_label_font = font.Font(self, size=16, weight=font.BOLD)
|
||||
self.title_label = ttk.Label(self, text="A title", font=self.title_label_font)
|
||||
self.title_label.grid(row=1, column=0, sticky=tk.NS, padx=2, pady=2)
|
||||
|
||||
# About content
|
||||
self.content_label_font = font.Font(self, size=10)
|
||||
self.content_label = ttk.Label(self, wraplength=400, justify='center', text='A long text', font=self.content_label_font, foreground='blue')
|
||||
self.content_label.grid(row=2, column=0, sticky=tk.NS)
|
||||
|
||||
# About version
|
||||
self.version_label = ttk.Label(self, text='version : 1.0.0 - 02-02-2022')
|
||||
self.version_label.grid(row=3, column=0, sticky=tk.NS, pady=15)
|
||||
|
||||
def __event_button_back(self) -> None:
|
||||
"""
|
||||
[internal function]
|
||||
=> Function called when back button pressed.
|
||||
"""
|
||||
self.__controller.on_change_view(Frames.HOME)
|
||||
# END Internal functions
|
||||
|
||||
# START Controller methods
|
||||
def set_title(self, title: str) -> None:
|
||||
"""
|
||||
[function for controller]
|
||||
=> Define view/page info : title
|
||||
|
||||
* :title: -> Title for the view.
|
||||
"""
|
||||
self.title_label.configure(text=title)
|
||||
|
||||
def set_content(self, content: str) -> None:
|
||||
"""
|
||||
[function for controller]
|
||||
=> Define view/page info : content
|
||||
|
||||
* :content: -> Content for the view.
|
||||
"""
|
||||
self.content_label.configure(text=content)
|
||||
|
||||
def set_version(self, version: str) -> None:
|
||||
"""
|
||||
[function for controller]
|
||||
=> Define view/page info : version
|
||||
|
||||
* :version: -> Version for the view.
|
||||
"""
|
||||
self.version_label.configure(text=version)
|
||||
# END Controller methods
|
||||
154
webpicdownloader/view/MainWindow.py
Normal file
154
webpicdownloader/view/MainWindow.py
Normal file
@@ -0,0 +1,154 @@
|
||||
import tkinter as tk
|
||||
from tkinter import messagebox
|
||||
from webpicdownloader.controller.Frames import Frames
|
||||
from webpicdownloader.controller.MainController import MainController
|
||||
|
||||
|
||||
class MainWindow(tk.Tk):
|
||||
"""
|
||||
View - MainWindow
|
||||
|
||||
This view is the main view of the application, it manages the different frames/views
|
||||
of the application, captures the events to send them to the main controller.
|
||||
|
||||
@author Jérémi Nihart / EndMove
|
||||
@link https://git.endmove.eu/EndMove/WebPicDownloader
|
||||
@version 1.0.1
|
||||
@since 2022-09-04
|
||||
"""
|
||||
# Variables
|
||||
__controller: MainController = None
|
||||
__views: dict = None
|
||||
__frame_id: int = None
|
||||
|
||||
# Constructor
|
||||
def __init__(self, controller: MainController) -> None:
|
||||
"""
|
||||
Constructor
|
||||
|
||||
* :controller: -> The main application cpntroller.
|
||||
"""
|
||||
super().__init__()
|
||||
|
||||
# Init view repository
|
||||
self.__views = {}
|
||||
|
||||
# Save and setup main controller
|
||||
self.__controller = controller
|
||||
controller.set_view(self)
|
||||
|
||||
# Init view components & more
|
||||
self.__init_window()
|
||||
self.__init_top_menu()
|
||||
self.__init_bind_protocol()
|
||||
|
||||
# START Internal methods
|
||||
def __init_window(self) -> None:
|
||||
"""
|
||||
[internal function]
|
||||
=> Initialize window parameters
|
||||
"""
|
||||
self.iconbitmap(f"{self.__controller.get_config('sys_directory')}\\webpicdownloader\\assets\\logo.ico") # App logo
|
||||
window_width = 430 # App width
|
||||
window_height = 305 # App height
|
||||
x_cordinate = int((self.winfo_screenwidth()/2) - (window_width/2))
|
||||
y_cordinate = int((self.winfo_screenheight()/2) - (window_height/2))
|
||||
self.geometry(f"{window_width}x{window_height}+{x_cordinate}+{y_cordinate}") # App size and middle centering
|
||||
self.resizable(False, False) # Disable app resizing
|
||||
|
||||
def __init_top_menu(self) -> None:
|
||||
"""
|
||||
[internal function]
|
||||
=> Initialize top menu of the window.
|
||||
"""
|
||||
main_menu = tk.Menu(self)
|
||||
|
||||
# Top menu File item
|
||||
col1_menu = tk.Menu(main_menu, tearoff=0)
|
||||
col1_menu.add_command(label="Open app folder", command=self.__controller.on_open_folder)
|
||||
col1_menu.add_separator()
|
||||
col1_menu.add_command(label="Quit", command=self.__controller.on_quite)
|
||||
main_menu.add_cascade(label="File", menu=col1_menu)
|
||||
|
||||
# Top menu Help item
|
||||
col2_menu = tk.Menu(main_menu, tearoff=0)
|
||||
col2_menu.add_command(label="Check for update", command=self.__controller.on_check_for_update)
|
||||
col2_menu.add_command(label="About", command=self.__controller.on_about)
|
||||
main_menu.add_cascade(label="Help", menu=col2_menu)
|
||||
|
||||
self.config(menu=main_menu)
|
||||
|
||||
def __init_bind_protocol(self) -> None:
|
||||
"""
|
||||
[internal function]
|
||||
=> Initialize the function bindding on events of the main window.
|
||||
"""
|
||||
self.protocol("WM_DELETE_WINDOW", self.__controller.on_quite)
|
||||
# END Internal methods
|
||||
|
||||
# START App methods
|
||||
def add_view(self, frame, view) -> None:
|
||||
"""
|
||||
[function for app]
|
||||
|
||||
* :frame: -> the frame id of the view to add.
|
||||
"""
|
||||
self.__views[frame] = view
|
||||
# END App methods
|
||||
|
||||
# START Controller methods
|
||||
def set_window_title(self, title: str) -> None:
|
||||
"""
|
||||
[function for controller]
|
||||
=> Sets the title of the main window.
|
||||
|
||||
* :title: -> Window title.
|
||||
"""
|
||||
self.title(title)
|
||||
|
||||
def show_frame(self, frame: Frames) -> None:
|
||||
"""
|
||||
[function for app & controller]
|
||||
=> Allows to display the selected frame provided that it
|
||||
has been previously added to the frame dictionary.
|
||||
|
||||
* :frame: -> the frame if of the view to display.
|
||||
"""
|
||||
if self.__views.get(frame):
|
||||
if self.__frame_id:
|
||||
self.__views.get(self.__frame_id).pack_forget()
|
||||
self.__views.get(frame).pack(fill=tk.BOTH, expand=False)
|
||||
self.__frame_id = frame
|
||||
else:
|
||||
raise ValueError("Unable to find the requested Frame")
|
||||
|
||||
def close_window(self) -> None:
|
||||
"""
|
||||
[function for controller]
|
||||
=> Closes the main window and stops the program from the controller.
|
||||
"""
|
||||
self.destroy()
|
||||
|
||||
def show_question_dialog(self, title: str, message: str, icon: str='question') -> bool:
|
||||
"""
|
||||
[function for controller]
|
||||
=> Display a question dialog to the user, which he can answer with yes or no.
|
||||
|
||||
* :title: -> Title of the dialogue.
|
||||
* :message: -> Message of the dialogue displayed to the user.
|
||||
* :icon: -> Icon of the dialogue displayed to the user.
|
||||
* RETURN -> True id the user selected yes, False else.
|
||||
"""
|
||||
return True if (messagebox.askquestion(title, message, icon=icon) == "yes") else False
|
||||
|
||||
def show_information_dialog(self, title: str, message: str, icon: str='info') -> None:
|
||||
"""
|
||||
[function for controller]
|
||||
=> Display an information dialog to the user.
|
||||
|
||||
* :title: -> Title of the dialogue.
|
||||
* :message: -> Message of the dialogue displayed to the user.
|
||||
* :icon: -> Icon of the dialogue displayed to the user.
|
||||
"""
|
||||
messagebox.showinfo(title, message, icon=icon)
|
||||
# END Controller methods
|
||||
Reference in New Issue
Block a user