summaryrefslogtreecommitdiff
path: root/grc/gui/MainWindow.py
diff options
context:
space:
mode:
Diffstat (limited to 'grc/gui/MainWindow.py')
-rw-r--r--grc/gui/MainWindow.py27
1 files changed, 13 insertions, 14 deletions
diff --git a/grc/gui/MainWindow.py b/grc/gui/MainWindow.py
index 067131ec96..f309d34a2e 100644
--- a/grc/gui/MainWindow.py
+++ b/grc/gui/MainWindow.py
@@ -121,7 +121,7 @@ class MainWindow(gtk.Window):
Handle the delete event from the main window.
Generated by pressing X to close, alt+f4, or right click+close.
This method in turns calls the state handler to quit.
-
+
Returns:
true
"""
@@ -133,7 +133,7 @@ class MainWindow(gtk.Window):
Handle a page change. When the user clicks on a new tab,
reload the flow graph to update the vars window and
call handle states (select nothing) to update the buttons.
-
+
Args:
notebook: the notebook
page: new page
@@ -150,12 +150,11 @@ class MainWindow(gtk.Window):
def add_report_line(self, line):
"""
Place line at the end of the text buffer, then scroll its window all the way down.
-
+
Args:
line: the new text
"""
self.text_display.insert(line)
- self.text_display.scroll_mark_onscreen(self.text_display.get_buffer().get_insert())
############################################################
# Pages: create and close
@@ -165,7 +164,7 @@ class MainWindow(gtk.Window):
"""
Create a new notebook page.
Set the tab to be selected.
-
+
Args:
file_path: optional file to load into the flow graph
show: true if the page should be shown after loading
@@ -203,7 +202,7 @@ class MainWindow(gtk.Window):
def close_pages(self):
"""
Close all the pages in this notebook.
-
+
Returns:
true if all closed
"""
@@ -228,7 +227,7 @@ class MainWindow(gtk.Window):
Close the current page.
If the notebook becomes empty, and ensure is true,
call new page upon exit to ensure that at least one page exists.
-
+
Args:
ensure: boolean
"""
@@ -258,7 +257,7 @@ class MainWindow(gtk.Window):
Set the title of the main window.
Set the titles on the page tabs.
Show/hide the reports window.
-
+
Args:
title: the window title
"""
@@ -286,7 +285,7 @@ class MainWindow(gtk.Window):
def get_page(self):
"""
Get the selected page.
-
+
Returns:
the selected page
"""
@@ -295,7 +294,7 @@ class MainWindow(gtk.Window):
def get_flow_graph(self):
"""
Get the selected flow graph.
-
+
Returns:
the selected flow graph
"""
@@ -317,7 +316,7 @@ class MainWindow(gtk.Window):
def _set_page(self, page):
"""
Set the current page.
-
+
Args:
page: the page widget
"""
@@ -327,7 +326,7 @@ class MainWindow(gtk.Window):
def _save_changes(self):
"""
Save changes to flow graph?
-
+
Returns:
true if yes
"""
@@ -339,7 +338,7 @@ class MainWindow(gtk.Window):
def _get_files(self):
"""
Get the file names for all the pages, in order.
-
+
Returns:
list of file paths
"""
@@ -348,7 +347,7 @@ class MainWindow(gtk.Window):
def _get_pages(self):
"""
Get a list of all pages in the notebook.
-
+
Returns:
list of pages
"""