1 files changed, 42 insertions, 0 deletions
diff --git a/mitmproxy/tools/console/layoutwidget.py b/mitmproxy/tools/console/layoutwidget.py
new file mode 100644
index 00000000..65332238
--- /dev/null
+++ b/mitmproxy/tools/console/layoutwidget.py
@@ -0,0 +1,42 @@
+
+
+class LayoutWidget:
+    """
+        All top-level layout widgets and all widgets that may be set in an
+        overlay must comply with this API.
+    """
+    # Title is only required for windows, not overlay components
+    title = ""
+    keyctx = ""
+
+    def key_responder(self):
+        """
+            Returns the object responding to key input. Usually self, but may be
+            a wrapped object.
+        """
+        return self
+
+    def focus_changed(self):
+        """
+            The view focus has changed. Layout objects should implement the API
+            rather than directly subscribing to events.
+        """
+        pass
+
+    def view_changed(self):
+        """
+            The view list has changed.
+        """
+        pass
+
+    def layout_popping(self):
+        """
+            We are just about to pop a window off the stack, or exit an overlay.
+        """
+        pass
+
+    def layout_pushed(self, prev):
+        """
+            We have just pushed a window onto the stack.
+        """
+        pass