summaryrefslogtreecommitdiffstats
path: root/examples/empty_class.py
diff options
context:
space:
mode:
authorUltrabug <ultrabug@gentoo.org>2014-05-03 19:36:39 +0200
committerUltrabug <ultrabug@gentoo.org>2014-05-03 19:36:39 +0200
commitd9f15faaf6a61380a51c99349932718a181513f4 (patch)
treedd19e9acbef005b1d920f9f4b2c45caae14b2dd3 /examples/empty_class.py
parent280a383cc84b048a686d4ac573e001a9b7891c46 (diff)
rename examples folder to the modules and prepare for installation
Diffstat (limited to 'examples/empty_class.py')
-rw-r--r--examples/empty_class.py41
1 files changed, 0 insertions, 41 deletions
diff --git a/examples/empty_class.py b/examples/empty_class.py
deleted file mode 100644
index 077269c..0000000
--- a/examples/empty_class.py
+++ /dev/null
@@ -1,41 +0,0 @@
-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)