Changeset 1212

Timestamp:

Dec 10, 2009, 5:04:53 PM (14 years ago)

Author:

garnier

Message:

update doc

File:

• trunk/documents/UserDoc/DocBookUsersGuides/ForApplicationDeveloper/xml/GettingStarted/graphicalUserInterface.xml (modified) (9 diffs)

trunk/documents/UserDoc/DocBookUsersGuides/ForApplicationDeveloper/xml/GettingStarted/graphicalUserInterface.xml

@@ -2 +2 @@
 <!--                                                          -->
 <!--  [History]                                               -->
+<!--    Update G4UIExecutive : Laurent Garnier, Dec-2009      -->
 <!--    Converted to DocBook: Katsuya Amako, Aug-2006         -->
 <!--                                                          -->
@@ -65 +66 @@
   </para></listitem>
   <listitem><para>
-  Xm, Xaw, Win32, variations of the upper terminal by using a
-  Motif, Athena or Windows widget to retrieve commands, and
+  Xm, Xaw, Win32, Qt variations of the upper terminal by using a
+  Motif, Athena, Qt or Windows widget to retrieve commands, and
   </para></listitem>
   <listitem><para>
@@ -225 +226 @@
 <sect3 id="sect.HowToSetUpInter.DescInter.G4UIXm">
 <title>
-<emphasis>G4UIXm</emphasis>, <emphasis>G4UIXaw</emphasis> and 
+<emphasis>G4UIXm</emphasis>, <emphasis>G4UIXaw</emphasis>, <emphasis>G4UIQt</emphasis> and 
 <emphasis>G4UIWin32</emphasis> classes
 </title>
@@ -231 +232 @@
 <para>
 These interfaces are versions of <emphasis>G4UIterminal</emphasis> 
-implemented over libraries Motif, Athena and WIN32 respectively. 
+implemented over libraries Motif, Athena, Qt and WIN32 respectively. 
 <emphasis>G4UIXm</emphasis> uses the Motif XmCommand widget, 
 <emphasis>G4UIXaw</emphasis> the Athena dialog
+widget, <emphasis>G4UIQt</emphasis> the Qt dialog
 widget, and <emphasis>G4UIWin32</emphasis> the Windows "edit" component to do the
 command capturing. These interfaces are useful if working in
-conjunction with visualization drivers that use the Xt library or
+conjunction with visualization drivers that use the Xt library, Qt library or
 the WIN32 one.
 </para>
@@ -278 +280 @@
 <para>
 <emphasis>G4UIXm</emphasis> runs on Unix/Linux with Motif. <emphasis>G4UIXaw</emphasis>, 
-less user friendly, runs on Unix with Athena widgets. 
+less user friendly, runs on Unix with Athena widgets. <emphasis>G4UIQt</emphasis> run 
+everywhere with Qt.
 <emphasis>G4UIWin32</emphasis> runs on Windows.
 </para>
@@ -400 +403 @@
 
 <para>
-To make the libraries of <emphasis>G4UIXm</emphasis>, <emphasis>G4UIXaw</emphasis> and
+To make the libraries of <emphasis>G4UIXm</emphasis>, <emphasis>G4UIXaw</emphasis>,
+ <emphasis>G4UIQt</emphasis> and
 <emphasis>G4UIWin32</emphasis> , respective environment variables
 <emphasis role="bold">G4UI_BUILD_XM_SESSION</emphasis>, 
-<emphasis role="bold">G4UI_BUILD_XAW_SESSION</emphasis> or
+<emphasis role="bold">G4UI_BUILD_XAW_SESSION</emphasis>,
+<emphasis role="bold">G4UI_BUILD_QT_SESSION</emphasis> or
 <emphasis role="bold">G4UI_BUILD_WIN32_SESSION</emphasis> must be set
 explicitly before creating libraries.
@@ -430 +435 @@
 <para>
 To use a given interface
-(<literal>G4UIxxx</literal> where <literal>xxx = terminal,Xm, Xaw, Win32,
-GAG, GainServer</literal>) in your program, you have  following
-lines in your main program;
-
-<informalexample>
-<programlisting>
-// to include the class definition in the main program:
+(<literal>G4UIxxx</literal> where <literal>xxx = terminal,Xm, Xaw, Win32, Qt, 
+GAG, GainServer</literal>) in your program, you can do it by two ways :
+<itemizedlist spacing="compact">
+   <listitem><para> Calling G4UIxxx directly :
+   <informalexample>
+   <programlisting>
    #include "G4Uixxx.hh"
 // to instantiate a session of your choice and start the session
@@ -443 +447 @@
 // the line next to the "SessionStart" is necessary to finish the session
    delete session;
+   </programlisting>
+   </informalexample>
+   Note : For a tcsh session, the second line must be (See the examples in "examples/novice/N0x" in which the terminal session is used) :
+
+   <informalexample>
+   <programlisting>
+      G4UIsession* session = new G4UIterminal(new G4UItcsh);
+   </programlisting>
+   </informalexample>
+   
+   </para></listitem>
+   <listitem><para>Using <emphasis>G4UIExecutive</emphasis> (implement in all novice examples) :
+     <informalexample>
+     <programlisting>
+// to include the class definition in the main program:
+   #ifdef G4UI_USE
+     #include "G4UIExecutive.hh"
+   #endif
+// to instantiate a session of your choice and start the session
+   #ifdef G4UI_USE
+     G4UIExecutive* ui = new G4UIExecutive(argc,argv);
+     ui-&gt;SessionStart();
+// the line next to the "SessionStart" is necessary to finish the session
+     delete ui;
+   #endif
+     </programlisting>
+     </informalexample>
+</para>
+</listitem>
+</itemizedlist>
+</para>
+
+<para>The two methods are similar. If you want to choose between several viewer driver at load, with the <emphasis>first</emphasis> method you will have to write :
+<informalexample>
+<programlisting>
+// to include the class definition in the main program:
+   #if defined(G4UI_USE_TCSH)
+     #include "G4UIterminal.hh"
+     #include "G4UItcsh.hh"
+   #elif defined(G4UI_USE_XM)
+     #include "G4UIXm.hh"
+   ....
+   #endif
+
+   #if defined(G4UI_USE_TCSH)
+     session = new G4UITerminal(new G4UITerminal);
+   #elif defined(G4UI_USE_XM)
+     session = new G4UIXm(argc,argv);
+   #elif ...
 </programlisting>
 </informalexample>
-</para>
-
-<para>
-For a tcsh session, the second line must be :
-
+That is not realy simple. The best way to do this is the <emphasis>second</emphasis> method :
 <informalexample>
 <programlisting>
-   G4UIsession* session = new G4UIterminal(new G4UItcsh);
+   #ifdef G4UI_USE
+     #include "G4UIExecutive.hh"
+   #endif
+...
+
+// to instantiate a session of your choice and start the session
+// G4UIExecutive will open for you the good driver (depending on G4UI_USE_xxx flags)
+   #ifdef G4UI_USE
+     G4UIExecutive* ui = new G4UIExecutive(argc,argv);
+   #endif
 </programlisting>
 </informalexample>
-</para>
-
-<para>
-See the examples in "examples/novice/N0x" in which the terminal session 
-is used.
-</para>
-
+
+</para>
 <para>
 If the user wants to deactivate the default signal handler (soft abort)
@@ -499 +552 @@
    <listitem><para>
    The environment variable <emphasis role="bold">G4UI_USE_XM</emphasis>, 
-   <emphasis role="bold">G4UI_USE_XAW</emphasis> or
+<emphasis role="bold">G4UI_USE_QT</emphasis>,   <emphasis role="bold">G4UI_USE_XAW</emphasis> or
    <emphasis role="bold">G4UI_USE_WIN32</emphasis> must be set to use the 
-   respective interface. The file "$G4INSTALL/config/interactivity.gmk"
+   respective interface. The file "$G4INSTALL/config/G4UI_USE.gmk"
    resolves their dependencies on external packages.
    </para></listitem>