tweaked comments, about to tidy

Author: shearn89

cascader-gui/bin/cascader-gui

@@ -16,6 +16,55 @@ ICON_ROOT = LIB_ROOT + '/icons'
 
 authors = ["Chris \'xoebus\' Brown", "Alex \'shearn89\' Shearn"]
 
+def get_cascader_info(user)
+    dialog = Gtk::Dialog.new("Cascader Info",
+                             $main_application_window,
+                             Gtk::Dialog::MODAL,
+                             [ Gtk::Stock::OK, Gtk::Dialog::RESPONSE_ACCEPT ],
+                             [ Gtk::Stock::CANCEL, Gtk::Dialog::RESPONSE_REJECT ])
+    dialog.set_default_size(300,100)
+    dialog.set_default_response(Gtk::Dialog::RESPONSE_ACCEPT)
+    
+    entry1 = Gtk::Entry.new
+    entry1.max_length=13
+    entry1.text = ENV['USER']
+    entry1.select_region(0,-1)
+
+    entry1lbl = Gtk::Label.new("Username: ")
+    entry2lbl = Gtk::Label.new("Topics: ")
+    
+    entry2 = Gtk::Entry.new
+    entry2.max_length=50
+    entry2.set_activates_default(true)
+    entry2.text = "comma,seperated,topics"
+    entry2.select_region(0,-1)
+    
+    tableholder = Gtk::Table.new(2,3,true)
+    
+    tableholder.attach(entry1lbl,0,1,0,1)
+    tableholder.attach(entry1,1,3,0,1)
+    tableholder.attach(entry2lbl,0,1,1,2)
+    tableholder.attach(entry2,1,3,1,2)
+    
+    dialog.vbox.add(tableholder)
+    
+    dialog.show_all
+    
+    dialog.run do |reply|
+    	case reply
+    		when Gtk::Dialog::RESPONSE_ACCEPT
+    			@details = [entry1.text,entry2.text]
+    			@server = ServerGui.new(@details[0], @user.hostname, @details[1])
+    			@first_run = false
+    	end
+    	dialog.destroy
+    end
+end
+
+#####
+###  WINDOW INIT
+#####
+
 window_icons=[
 	Gdk::Pixbuf.new(ICON_ROOT+"/cascade16.png"),
 	Gdk::Pixbuf.new(ICON_ROOT+"/cascade32.png"),
@@ -26,23 +75,22 @@ window_icons=[
 window = Gtk::Window.new
 window.set_default_size(400,200)
 window.icon_list=(window_icons)
-# window.default_icon_list=(window_icons)
 window.signal_connect("delete_event") {
 	window.hide_all
 }
 
 
 #####
-### System tray
+###  SYSTEM TRAY
 #####
+
 si=Gtk::StatusIcon.new
-# si.stock=Gtk::Stock::DIALOG_INFO
 hearticon = Gdk::Pixbuf.new(LIB_ROOT + '/icons/cascade32.png')
 monkeyicon = Gdk::Pixbuf.new(LIB_ROOT + '/icons/cascading32.png')
 si.pixbuf=Gdk::Pixbuf.new(LIB_ROOT + '/icons/cascade32.png')
 si.tooltip='Cascader'
 
-# RIGHT CLICK
+# RIGHT CLICK MENU
 ## need both scascade and cascadebutton here in order for label changing to work.
 scascade=Gtk::ImageMenuItem.new(label="Cascade", use_underline=false)
 cascadebutton = Gtk::ToggleButton.new(label = "Cascade")
@@ -76,7 +124,7 @@ sabout.signal_connect('activate'){
 	aboutdialog.hide
 	}
 
-# LEFT CLICK
+# LEFT CLICK TOGGLE
 si.signal_connect('activate'){
 	if @first_run
 		@user = UserGui.new
@@ -100,64 +148,26 @@ simenu.show_all
 si.signal_connect('popup-menu'){|tray, button, time| simenu.popup(nil, nil, button, time)}
 
 #####
-### MAIN WINDOW
+###  MAIN WINDOW FUNCTIONS
 #####
 
 table1 = Gtk::Table.new(2, 3, true)
 
+#####
+###  FIND A CASCADER
+#####
+
 findbutton = Gtk::Button.new("Find a Cascader")
 findbutton.signal_connect("clicked") { |b|
 	@user = UserGui.new
 	client = ClientGui.new(@user)
   	client.search(window)
 }
 
-def get_cascader_info(user)
-    dialog = Gtk::Dialog.new("Cascader Info",
-                             $main_application_window,
-                             Gtk::Dialog::MODAL,
-                             [ Gtk::Stock::OK, Gtk::Dialog::RESPONSE_ACCEPT ],
-                             [ Gtk::Stock::CANCEL, Gtk::Dialog::RESPONSE_REJECT ])
-    dialog.set_default_size(300,100)
-    dialog.set_default_response(Gtk::Dialog::RESPONSE_ACCEPT)
-    
-    entry1 = Gtk::Entry.new
-    entry1.max_length=13
-    entry1.text = ENV['USER']
-    entry1.select_region(0,-1)
-
-    entry1lbl = Gtk::Label.new("Username: ")
-    entry2lbl = Gtk::Label.new("Topics: ")
-    
-    entry2 = Gtk::Entry.new
-    entry2.max_length=50
-    entry2.set_activates_default(true)
-    entry2.text = "comma,seperated,topics"
-    entry2.select_region(0,-1)
-    
-    tableholder = Gtk::Table.new(2,3,true)
-    
-    tableholder.attach(entry1lbl,0,1,0,1)
-    tableholder.attach(entry1,1,3,0,1)
-    tableholder.attach(entry2lbl,0,1,1,2)
-    tableholder.attach(entry2,1,3,1,2)
-    
-    dialog.vbox.add(tableholder)
-    
-    dialog.show_all
-    
-    dialog.run do |reply|
-    	case reply
-    		when Gtk::Dialog::RESPONSE_ACCEPT
-    			@details = [entry1.text,entry2.text]
-    			@server = ServerGui.new(@details[0], @user.hostname, @details[1])
-    			@first_run = false
-    	end
-    	dialog.destroy
-    end
-end
+#####
+###  CASCADE
+#####
 
-# CASCADE BUTTON
 cascadebutton.signal_connect("toggled") { |w|
 	w.active? ? false : true
 
@@ -173,6 +183,9 @@ cascadebutton.signal_connect("toggled") { |w|
 	end
 }
 
+#####
+###  ABOUT
+#####
 
 aboutdialog.name = "Cascader"
 aboutdialog.version = "1.0"
@@ -181,19 +194,26 @@ aboutdialog.license = "This program shared under a Creative Commons license.\nSe
 aboutdialog.website = "http://github.com/shearn89/cascader-gui"
 aboutdialog.website_label = "Fork us on GitHub"
 aboutdialog.authors = authors
-# aboutdialog.logo = Gdk::Pixbuf.new(LIB_ROOT + '/icons/300x100-license.png')
 
 about = Gtk::Button.new("About")
 about.signal_connect("clicked") {
 	aboutdialog.run
 	aboutdialog.hide
 }
 
+#####
+###  EXIT
+#####
+
 exitbutton = Gtk::Button.new("Quit")
 exitbutton.signal_connect("clicked") {
 	Gtk.main_quit
 }
 
+#####
+###  GENERAL START
+#####
+
 window.border_width = 10
 window.add(table1)