aboutsummaryrefslogtreecommitdiffstats
path: root/.i3/py3status/backup/empty_class.py
diff options
context:
space:
mode:
Diffstat (limited to '.i3/py3status/backup/empty_class.py')
-rw-r--r--.i3/py3status/backup/empty_class.py41
1 files changed, 41 insertions, 0 deletions
diff --git a/.i3/py3status/backup/empty_class.py b/.i3/py3status/backup/empty_class.py
new file mode 100644
index 0000000..077269c
--- /dev/null
+++ b/.i3/py3status/backup/empty_class.py
@@ -0,0 +1,41 @@
+class Py3status:
+ """
+ Empty and basic py3status class.
+
+ NOTE: py3status will NOT execute:
+ - methods starting with '_'
+ - methods decorated by @property and @staticmethod
+
+ NOTE: reserved method names:
+ - 'kill' method for py3status exit notification
+ - 'on_click' method for click events from i3bar
+ """
+ def kill(self, i3status_output_json, i3status_config):
+ """
+ This method will be called upon py3status exit.
+ """
+ pass
+
+ def on_click(self, i3status_output_json, i3status_config, event):
+ """
+ This method will be called when a click event occurs on this module's
+ output on the i3bar.
+
+ Example 'event' json object:
+ {'y': 13, 'x': 1737, 'button': 1, 'name': 'empty', 'instance': 'first'}
+ """
+ pass
+
+ def empty(self, i3status_output_json, i3status_config):
+ """
+ This method will return an empty text message
+ so it will NOT be displayed on your i3bar.
+
+ If you want something displayed you should write something
+ in the 'full_text' key of your response.
+
+ See the i3bar protocol spec for more information:
+ http://i3wm.org/docs/i3bar-protocol.html
+ """
+ response = {'full_text': '', 'name': 'empty', 'instance': 'first'}
+ return (0, response)