polish error report UI

svn: r5700

gramps2/ChangeLog

@@ -1,3 +1,8 @@
+2006-01-08 Richard Taylor <rjt-gramps@thegrindstone.me.uk>
+	* src/Assistant.py: remove print statement
+	* src/GrampsLogger/_ErrorReportAssistant.py: polish UI and added option
+	to start email client.
+	
 2006-01-08  Don Allingham  <don@gramps-project.org>
 	* src/person.svg: new icon
 	* src/gramps_main.py: add person.svg

gramps2/src/Assistant.py

@@ -122,7 +122,6 @@ class Assistant(gtk.Object):
         self.title.set_use_markup(True)
 
     def set_buttons(self):
-	print "current_page = ", self.current_page
         if self.current_page == self.max_page-1:
 	    self.next.show()
 	    self.back.show()

gramps2/src/GrampsLogger/_ErrorReportAssistant.py

@@ -25,26 +25,24 @@ class ErrorReportAssistant:
                            "The assistant will ask you a few questions and will "\
                            "gather some information about the error that has "\
                            "occured and the operating environment. "\
-                           "At the end of the assistent you will be asked to "\
+                           "At the end of the assistant you will be asked to "\
                            "send an email to the Gramps bug reporting mailing list. "\
                            "The assistant will place the bug report on the clip board so "\
                            "that you can paste it into your email programme and review "\
                            "exactly what information is being sent."))
 
 
-        self.w.add_page(_("Error Details"), self.build_page1())
+        self.w.add_page(_("Report a bug: Step 1 of 5"), self.build_page1())
-        self.w.add_page(_("System Information"), self.build_page2())
+        self.w.add_page(_("Report a bug: Step 2 of 5"), self.build_page2())
-        self.w.add_page(_("Further Information"), self.build_page3())
+        self.w.add_page(_("Report a bug: Step 3 of 5"), self.build_page3())
         
         page4 = self.build_page4()
-        self.w.add_page(_("Summary"), page4)
+        self.w.add_page(_("Report a bug: Step 4 of 5"), page4)
         self.cb = {4:self.page4_update}
+        self.w.add_page(_("Report a bug: Step 5 of 5"), self.build_page5())
 
         self.w.set_conclusion(_('Complete'),
-                              _('The error report will be copied to your clipboard when you click OK. \n'
+                              _('GRAMPS is an Open Source project. Its success '
-                                'Please paste the report into your favourite email client and send it to: \n\n'
-                                'gramps-bugs@lists.sourceforge.net\n\n'
-                                'GRAMPS is an Open Source project. Its success '
                                 'depends on the users. User feedback is important. '
                                 'Thankyou for taking the time to submit a bug report.'))
 
@@ -57,6 +55,9 @@ class ErrorReportAssistant:
             self.cb[page]()
             
     def complete(self):
+        pass
+
+    def _copy_to_clipboard(self,obj=None):
         clipboard = gtk.Clipboard()
         clipboard.set_text(
             self._final_report_text_buffer.get_text(
@@ -69,6 +70,13 @@ class ErrorReportAssistant:
               self._final_report_text_buffer.get_start_iter(),
               self._final_report_text_buffer.get_end_iter()))
 
+    def _start_email_client(self,obj=None):
+        import GrampsDisplay
+        GrampsDisplay.url('mailto:gramps-bugs@lists.sourceforge.net&subject="bug report"&body="%s"' \
+                          % self._final_report_text_buffer.get_text(
+                               self._final_report_text_buffer.get_start_iter(),
+                               self._final_report_text_buffer.get_end_iter()))
+        
     def _get_sys_information(self):
         return "Python version: %s \n"\
                "Gramps version: %s \n"\
@@ -79,88 +87,178 @@ class ErrorReportAssistant:
                   os.uname()[0],
                   os.uname()[2])
 
+    def _reset_error_details_text_buffer(self,obj=None):
+        self._error_details_text_buffer.set_text(
+	    "\n".join(self._rotate_handler.get_formatted_log(self._error_detail.get_record())) +
+	    "\n\n" + 
+	    self._error_detail.get_formatted_log())
+
+    def _clear_error_details_text_buffer(self,obj=None):
+        self._error_details_text_buffer.delete(
+            self._error_details_text_buffer.get_start_iter(),
+            self._error_details_text_buffer.get_end_iter())
+
+    def _reset_sys_information_text_buffer(self,obj=None):
+        self._sys_information_text_buffer.set_text(
+            self._get_sys_information())
+
+    def _clear_sys_information_text_buffer(self,obj=None):
+        self._sys_information_text_buffer.delete(
+            self._sys_information_text_buffer.get_start_iter(),
+            self._sys_information_text_buffer.get_end_iter())
+
+    def _clear_user_information_text_buffer(self,obj=None):
+        self._user_information_text_buffer.delete(
+            self._user_information_text_buffer.get_start_iter(),
+            self._user_information_text_buffer.get_end_iter())
+
+
     def build_page1(self):
-
+        label = gtk.Label(_("If you can see that there is any personal "\
-        box = gtk.VBox()
+                            "information included in the error please remove it."))
-
+        label.set_alignment(0.01,0.5)
-        label = gtk.Label(_("This is the detailed Gramps error information, don't worry if you "\
+        label.set_padding(0, 4)
-                            "do not understand it. If you can see that there is any personal "\
-                            "information included in the error please remove it. You "\
-                            "will have the opportunity to add further detail about the error "\
-                            "in the following pages of the assistant."))
-
         label.set_line_wrap(True)
 
-        box.pack_start(label,False,False,5)
-
         sw = gtk.ScrolledWindow()
         sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
 
         textview = gtk.TextView()
 
         self._error_details_text_buffer = textview.get_buffer()
-        self._error_details_text_buffer.set_text(
+        self._reset_error_details_text_buffer()
-	    "\n".join(self._rotate_handler.get_formatted_log(self._error_detail.get_record())) +
-	    "\n\n" + 
-	    self._error_detail.get_formatted_log())
             
         sw.add(textview)
         sw.show()
         textview.show()
 
-	frm = gtk.Frame()
+        sw_frame = gtk.Frame()
-	frm.add(sw)
+        sw_frame.add(sw)
         
-        box.pack_start(frm)
+        reset = gtk.Button("Reset")
+        reset.connect('clicked', self._reset_error_details_text_buffer)
+        clear = gtk.Button("Clear")
+        clear.connect('clicked', self._clear_error_details_text_buffer)
+
+        button_box = gtk.HButtonBox()
+        button_box.set_border_width(6)
+        button_box.set_spacing(6)
+        button_box.set_layout(gtk.BUTTONBOX_END)
+
+        button_box.pack_end(reset,False,False)
+        button_box.pack_end(clear,False,False)
+
+        error_details_box = gtk.VBox()
+        error_details_box.pack_start(label,False,False)
+        error_details_box.pack_start(sw_frame,True,True)
+        error_details_box.pack_start(button_box,False,False)
+
+        error_details_align = gtk.Alignment(0,0,1,1)
+        error_details_align.set_padding(0,0,11,0)
+        error_details_align.add(error_details_box)
+        
+        error_details_frame = gtk.Frame()
+        error_details_frame.set_border_width(3)
+        error_details_frame.set_label("<b>%s</b>" % _("Error Details"))
+        error_details_frame.get_label_widget().set_use_markup(True)
+
+        error_details_frame.add(error_details_align)
+
+        side_label = gtk.Label(_("This is the detailed Gramps error information, don't worry if you "\
+                                 "do not understand it. You "\
+                                 "will have the opportunity to add further detail about the error "\
+                                 "in the following pages of the assistant."))
+
+        side_label.set_line_wrap(True)
+        side_label.set_size_request(124, -1)
+
+        box = gtk.HBox()
+
+        box.pack_start(side_label,False,False,5)
+
+        box.pack_start(error_details_frame)
         box.show_all()
 
         return box
 
     def build_page2(self):
-
-        box = gtk.VBox()
-
         label = gtk.Label(_("Please check the information below and correct anything that "\
                             "you know to be wrong or remove anything that you would rather not "\
                             "have included in the bug report."))
-
+        label.set_alignment(0.01,0.5)
+        label.set_padding(0, 4)
         label.set_line_wrap(True)
 
-        box.pack_start(label,False,False,5)
-
         sw = gtk.ScrolledWindow()
         sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
+
         textview = gtk.TextView()
 
         self._sys_information_text_buffer = textview.get_buffer()
-        self._sys_information_text_buffer.set_text(
+        self._reset_sys_information_text_buffer()
-            self._get_sys_information())
 
         sw.add(textview)
         sw.show()
         textview.show()
 
-	frm = gtk.Frame()
+        sw_frame = gtk.Frame()
-	frm.add(sw)
+        sw_frame.add(sw)
         
-        box.pack_start(frm)
+        reset = gtk.Button("Reset")
+        reset.connect('clicked', self._reset_sys_information_text_buffer)
+        clear = gtk.Button("Clear")
+        clear.connect('clicked', self._clear_sys_information_text_buffer)
+
+
+        button_box = gtk.HButtonBox()
+        button_box.set_border_width(6)
+        button_box.set_spacing(6)
+        button_box.set_layout(gtk.BUTTONBOX_END)
+
+        button_box.pack_end(reset,False,False)
+        button_box.pack_end(clear,False,False)
+
+        sys_information_box = gtk.VBox()
+        sys_information_box.pack_start(label,False,False)
+        sys_information_box.pack_start(sw_frame,True,True)
+        sys_information_box.pack_start(button_box,False,False)
+
+        sys_information_align = gtk.Alignment(0,0,1,1)
+        sys_information_align.set_padding(0,0,11,0)
+        sys_information_align.add(sys_information_box)
+        
+        sys_information_frame = gtk.Frame()
+        sys_information_frame.set_border_width(3)
+        sys_information_frame.set_label("<b>%s</b>" % _("System Information"))
+        sys_information_frame.get_label_widget().set_use_markup(True)
+
+        sys_information_frame.add(sys_information_align)
+
+        side_label = gtk.Label(_("This is the information about your system that "\
+                                 "will help the developers to fix the bug."))
+
+        side_label.set_line_wrap(True)
+        side_label.set_size_request(124, -1)
+
+        box = gtk.HBox()
+
+        box.pack_start(side_label,False,False,5)
+
+        box.pack_start(sys_information_frame)
         box.show_all()
 
         return box
 
     def build_page3(self):
-
-        box = gtk.VBox()
-
         label = gtk.Label(_("Please provide as much information as you can "\
-                            "about what you were doing when the error occured. "))
+                             "about what you were doing when the error occured. "))
-
+        label.set_alignment(0.01,0.5)
+        label.set_padding(0, 4)
         label.set_line_wrap(True)
 
-        box.pack_start(label,False,False,5)
-
         sw = gtk.ScrolledWindow()
         sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
+
         textview = gtk.TextView()
 
         self._user_information_text_buffer = textview.get_buffer()
@@ -169,32 +267,63 @@ class ErrorReportAssistant:
         sw.show()
         textview.show()
 
-	frm = gtk.Frame()
+        sw_frame = gtk.Frame()
-	frm.add(sw)
+        sw_frame.add(sw)
         
-        box.pack_start(frm)
+        clear = gtk.Button("Clear")
+        clear.connect('clicked',self._clear_user_information_text_buffer)
+
+        button_box = gtk.HButtonBox()
+        button_box.set_border_width(6)
+        button_box.set_spacing(6)
+        button_box.set_layout(gtk.BUTTONBOX_END)
+
+        button_box.pack_end(clear,False,False)
+
+        user_information_box = gtk.VBox()
+        user_information_box.pack_start(label,False,False)
+        user_information_box.pack_start(sw_frame,True,True)
+        user_information_box.pack_start(button_box,False,False)
+
+        user_information_align = gtk.Alignment(0,0,1,1)
+        user_information_align.set_padding(0,0,11,0)
+        user_information_align.add(user_information_box)
+        
+        user_information_frame = gtk.Frame()
+        user_information_frame.set_border_width(3)
+        user_information_frame.set_label("<b>%s</b>" % _("Further Information"))
+        user_information_frame.get_label_widget().set_use_markup(True)
+
+        user_information_frame.add(user_information_align)
+
+        side_label = gtk.Label(_("This is your opportunity to describe what you were "\
+                                 "doing when the error occured."))
+
+        side_label.set_line_wrap(True)
+        side_label.set_size_request(124, -1)
+
+        box = gtk.HBox()
+
+        box.pack_start(side_label,False,False,5)
+
+        box.pack_start(user_information_frame)
         box.show_all()
 
         return box
 
 
     def build_page4(self):
-
+        label = gtk.Label(_("Please check that the information is correct, do not worry if you "\
-        box = gtk.VBox()
-
-        label = gtk.Label(_("The complete bug report is shown below. When you click Forward it will "\
-                            "be copied onto the clickboard and you will be asked to email it.\n"\
-                            "Please check that the information is correct, do not worry if you "\
                             "don't understand the detail of the error information. Just make sure "\
                             "that it does not contain anything that you do not want to be sent "\
                             "to the developers."))
-
+        label.set_alignment(0.01,0.5)
+        label.set_padding(0, 4)
         label.set_line_wrap(True)
 
-        box.pack_start(label,False,False,5)
-
         sw = gtk.ScrolledWindow()
         sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)
+
         textview = gtk.TextView()
         textview.set_editable(False)
         textview.set_cursor_visible(False)
@@ -205,27 +334,151 @@ class ErrorReportAssistant:
         sw.show()
         textview.show()
 
-	frm = gtk.Frame()
+        sw_frame = gtk.Frame()
-	frm.add(sw)
+        sw_frame.add(sw)
         
-        box.pack_start(frm)
+        summary_box = gtk.VBox()
+        summary_box.pack_start(label,False,False)
+        summary_box.pack_start(sw_frame,True,True)
+
+        summary_align = gtk.Alignment(0,0,1,1)
+        summary_align.set_padding(0,0,11,0)
+        summary_align.add(summary_box)
+        
+        summary_frame = gtk.Frame()
+        summary_frame.set_border_width(3)
+        summary_frame.set_label("<b>%s</b>" % _("Bug Report Summary"))
+        summary_frame.get_label_widget().set_use_markup(True)
+
+        summary_frame.add(summary_align)
+
+        side_label = gtk.Label(_("This is the completed bug report. The next page "\
+                                 "of the assistant will help you to send the report "\
+                                 "to the bug report mailing list."))
+
+        side_label.set_line_wrap(True)
+        side_label.set_size_request(124, -1)
+
+        box = gtk.HBox()
+
+        box.pack_start(side_label,False,False,5)
+
+        box.pack_start(summary_frame)
         box.show_all()
 
         return box
 
+    def build_page5(self):
+        label = gtk.Label("%s <i>%s</i>" % (_("Use one of the two methods below to send the "\
+                                              "bug report to the Gramp bug reporting mailing "\
+                                              "list at "),"gramps-bugs@lists.sourceforge.net."))
+        label.set_alignment(0.01,0.5)
+        label.set_padding(0, 4)
+        label.set_line_wrap(True)
+        label.set_use_markup(True)
+
+
+        url_label = gtk.Label(_("If your email client is configured correctly you may be able "\
+                                "to use this button to start it with the bug report ready to send. "))
+        url_label.set_alignment(0.01,0.5)
+        url_label.set_padding(0, 4)
+        url_label.set_line_wrap(True)
+
+        url_button = gtk.Button("Start email client")
+        url_button.connect('clicked', self._start_email_client)
+        url_button_vbox = gtk.VBox()
+        url_button_vbox.pack_start(url_button,True,False)
+        
+        url_box = gtk.HBox()
+        url_box.pack_start(url_label,True,True)
+        url_box.pack_start(url_button_vbox,False,False)
+
+
+        url_align = gtk.Alignment(0,0,1,1)
+        url_align.set_padding(0,0,11,0)
+        url_align.add(url_box)
+
+        url_frame = gtk.Frame()
+        url_frame.add(url_align)
+        
+        clip_label = gtk.Label(_("If your email program fails to start you can use this button "
+                                 "to copy the bug report onto the clipboard. Then start your "
+                                 "email client, paste the report and send it to the address "
+                                 "above."))
+        clip_label.set_alignment(0.01,0.5)
+        clip_label.set_padding(0, 4)
+        clip_label.set_line_wrap(True)
+
+        clip_button = gtk.Button("Copy to clipboard")
+        clip_button.connect('clicked', self._copy_to_clipboard)
+        clip_button_vbox = gtk.VBox()
+        clip_button_vbox.pack_start(clip_button,True,False)
+        
+        clip_box = gtk.HBox()
+        clip_box.pack_start(clip_label,True,True)
+        clip_box.pack_start(clip_button_vbox,False,False)
+
+
+        clip_align = gtk.Alignment(0,0,1,1)
+        clip_align.set_padding(0,0,11,0)
+        clip_align.add(clip_box)
+
+        clip_frame = gtk.Frame()
+        clip_frame.add(clip_align)
+        
+
+        inner_box = gtk.VBox()
+        inner_box.pack_start(label,False,False)
+        inner_box.pack_start(url_frame,False,False)
+        inner_box.pack_start(clip_frame,False,False)
+
+        inner_align = gtk.Alignment(0,0,1,1)
+        inner_align.set_padding(0,0,11,0)
+        inner_align.add(inner_box)
+        
+        outer_frame = gtk.Frame()
+        outer_frame.set_border_width(3)
+        outer_frame.set_label("<b>%s</b>" % _("Send Bug Report"))
+        outer_frame.get_label_widget().set_use_markup(True)
+
+        outer_frame.add(inner_align)
+
+        side_label = gtk.Label(_("This is the final step. Use the buttons on this "
+                                 "page to transfer the bug report to your email client."))
+
+        side_label.set_line_wrap(True)
+        side_label.set_size_request(124, -1)
+
+        box = gtk.HBox()
+
+        box.pack_start(side_label,False,False,5)
+
+        box.pack_start(outer_frame)
+        box.show_all()
+
+        return box
+
+
     def page4_update(self):
 
         self._final_report_text_buffer.set_text(
-            "System Information: \n\n" +
+            "User Information: \n" +
-            self._sys_information_text_buffer.get_text(
+            "===================\n\n" +
-              self._sys_information_text_buffer.get_start_iter(),
-              self._sys_information_text_buffer.get_end_iter()) +
-            "\nAdditional Information: \n\n" +
             self._user_information_text_buffer.get_text(
               self._user_information_text_buffer.get_start_iter(),
               self._user_information_text_buffer.get_end_iter()) +
-            "\nError Details: \n\n" +
+
+            "\n\nError Details: \n" +
+            "===================\n\n" +
+
             self._error_details_text_buffer.get_text(
               self._error_details_text_buffer.get_start_iter(),
-              self._error_details_text_buffer.get_end_iter())            
+              self._error_details_text_buffer.get_end_iter()) +
+
+            "\n\nSystem Information: \n" +
+            "===================\n\n" +
+
+            self._sys_information_text_buffer.get_text(
+              self._sys_information_text_buffer.get_start_iter(),
+              self._sys_information_text_buffer.get_end_iter())             
             )