toktokkie.utils.iconizing.procedures package¶

Submodules¶

toktokkie.utils.iconizing.procedures.GnomeProcedure module¶

class toktokkie.utils.iconizing.procedures.GnomeProcedure.GnomeProcedure¶

Bases: toktokkie.utils.iconizing.procedures.Procedure.Procedure

Iconizing Procedure that uses the gio command line tool to set the icon file in gnome-based systems

classmethod iconize(directory: str, png_icon_path: str)¶: Iconizes the directory using gio :param directory: The directory to iconize :param png_icon_path: The path to the png icon file :return: None

classmethod is_applicable() → bool¶: Checks if this procedure is applicable to the current system. The Gnome procedure is applicable if the system is running Linux as well as a Gnome environment, like the Gnome DE or Cinnamon :return: True if applicable, else False

toktokkie.utils.iconizing.procedures.NoopProcedure module¶

class toktokkie.utils.iconizing.procedures.NoopProcedure.NoopProcedure¶

Bases: toktokkie.utils.iconizing.procedures.Procedure.Procedure

Iconizing Procedure that does nothing. Used as a fallback when no other procedures are available

classmethod iconize(directory: str, png_icon_path: str)¶: Doesn’t do anything :param directory: The directory to iconize :param png_icon_path: The path to the png icon file :return: None

classmethod is_applicable() → bool¶: Checks if this procedure is applicable to the current system. NOOP Procedure is always applicable :return: True if applicable, else False

toktokkie.utils.iconizing.procedures.Procedure module¶

class toktokkie.utils.iconizing.procedures.Procedure.Procedure¶

Bases: object

Interface that defines the methods an iconizing procedure must provide

classmethod iconize(directory: str, png_icon_path: str)¶: Iconizes a directory with an icon file :param directory: The directory to iconize :param png_icon_path: The path to the png icon file :return: None

classmethod is_applicable() → bool¶: Checks if this procedure is applicable to the current system :return: True if applicable, else False

name = 'procedure'¶: The name/identifier of the procedure

Module contents¶

This file is part of toktokkie.

toktokkie is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

toktokkie is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with toktokkie. If not, see <http://www.gnu.org/licenses/>.