1"""LICENSE 

2Copyright 2015 Hermann Krumrey <hermann@krumreyh.com> 

3 

4This file is part of toktokkie. 

5 

6toktokkie is free software: you can redistribute it and/or modify 

7it under the terms of the GNU General Public License as published by 

8the Free Software Foundation, either version 3 of the License, or 

9(at your option) any later version. 

10 

11toktokkie is distributed in the hope that it will be useful, 

12but WITHOUT ANY WARRANTY; without even the implied warranty of 

13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

14GNU General Public License for more details. 

15 

16You should have received a copy of the GNU General Public License 

17along with toktokkie. If not, see <http://www.gnu.org/licenses/>. 

18LICENSE""" 

19 

20 

21class Procedure: 

22 """ 

23 Interface that defines the methods an iconizing procedure must provide 

24 """ 

25 

26 name = "procedure" 

27 """ 

28 The name/identifier of the procedure 

29 """ 

30 

31 @classmethod 

32 def iconize(cls, directory: str, png_icon_path: str): 

33 """ 

34 Iconizes a directory with an icon file 

35 :param directory: The directory to iconize 

36 :param png_icon_path: The path to the png icon file 

37 :return: None 

38 """ 

39 raise NotImplementedError() # pragma: no cover 

40 

41 @classmethod 

42 def is_applicable(cls) -> bool: 

43 """ 

44 Checks if this procedure is applicable to the current system 

45 :return: True if applicable, else False 

46 """ 

47 raise NotImplementedError() # pragma: no cover