]> SALOME platform Git repositories - modules/gui.git/commitdiff
Salome HOME
NPAL15530: implement 'Help' button for 'Plot2d View Settings' dlg.
authorjfa <jfa@opencascade.com>
Thu, 22 Nov 2007 08:31:50 +0000 (08:31 +0000)
committerjfa <jfa@opencascade.com>
Thu, 22 Nov 2007 08:31:50 +0000 (08:31 +0000)
17 files changed:
doc/salome/gui/GUI/images/plot2d_clone.gif [new file with mode: 0644]
doc/salome/gui/GUI/images/plot2d_legend.gif [new file with mode: 0644]
doc/salome/gui/GUI/images/plot2d_lines.gif [new file with mode: 0644]
doc/salome/gui/GUI/images/plot2d_logarithmic_horizontal.gif [new file with mode: 0644]
doc/salome/gui/GUI/images/plot2d_logarithmic_vertical.gif [new file with mode: 0644]
doc/salome/gui/GUI/images/plot2d_points.gif [new file with mode: 0644]
doc/salome/gui/GUI/images/plot2d_settings.gif [new file with mode: 0644]
doc/salome/gui/GUI/images/plot2d_splines.gif [new file with mode: 0644]
doc/salome/gui/GUI/images/plot2d_view_settings.png [new file with mode: 0644]
doc/salome/gui/GUI/input/gui_module_chapter.doc
doc/salome/gui/GUI/input/index.doc
doc/salome/gui/GUI/input/plot2d_viewer.doc [new file with mode: 0644]
doc/salome/gui/GUI/input/viewers_chapter.doc
src/Plot2d/Plot2d_SetupViewDlg.cxx
src/Plot2d/Plot2d_SetupViewDlg.h
src/SUIT/SUIT_Application.cxx
src/SUIT/SUIT_Application.h

diff --git a/doc/salome/gui/GUI/images/plot2d_clone.gif b/doc/salome/gui/GUI/images/plot2d_clone.gif
new file mode 100644 (file)
index 0000000..f980a5d
Binary files /dev/null and b/doc/salome/gui/GUI/images/plot2d_clone.gif differ
diff --git a/doc/salome/gui/GUI/images/plot2d_legend.gif b/doc/salome/gui/GUI/images/plot2d_legend.gif
new file mode 100644 (file)
index 0000000..a40211e
Binary files /dev/null and b/doc/salome/gui/GUI/images/plot2d_legend.gif differ
diff --git a/doc/salome/gui/GUI/images/plot2d_lines.gif b/doc/salome/gui/GUI/images/plot2d_lines.gif
new file mode 100644 (file)
index 0000000..8d1dc23
Binary files /dev/null and b/doc/salome/gui/GUI/images/plot2d_lines.gif differ
diff --git a/doc/salome/gui/GUI/images/plot2d_logarithmic_horizontal.gif b/doc/salome/gui/GUI/images/plot2d_logarithmic_horizontal.gif
new file mode 100644 (file)
index 0000000..3473ad9
Binary files /dev/null and b/doc/salome/gui/GUI/images/plot2d_logarithmic_horizontal.gif differ
diff --git a/doc/salome/gui/GUI/images/plot2d_logarithmic_vertical.gif b/doc/salome/gui/GUI/images/plot2d_logarithmic_vertical.gif
new file mode 100644 (file)
index 0000000..0d3b25e
Binary files /dev/null and b/doc/salome/gui/GUI/images/plot2d_logarithmic_vertical.gif differ
diff --git a/doc/salome/gui/GUI/images/plot2d_points.gif b/doc/salome/gui/GUI/images/plot2d_points.gif
new file mode 100644 (file)
index 0000000..6700f00
Binary files /dev/null and b/doc/salome/gui/GUI/images/plot2d_points.gif differ
diff --git a/doc/salome/gui/GUI/images/plot2d_settings.gif b/doc/salome/gui/GUI/images/plot2d_settings.gif
new file mode 100644 (file)
index 0000000..87e1105
Binary files /dev/null and b/doc/salome/gui/GUI/images/plot2d_settings.gif differ
diff --git a/doc/salome/gui/GUI/images/plot2d_splines.gif b/doc/salome/gui/GUI/images/plot2d_splines.gif
new file mode 100644 (file)
index 0000000..1d50b20
Binary files /dev/null and b/doc/salome/gui/GUI/images/plot2d_splines.gif differ
diff --git a/doc/salome/gui/GUI/images/plot2d_view_settings.png b/doc/salome/gui/GUI/images/plot2d_view_settings.png
new file mode 100644 (file)
index 0000000..79dcc49
Binary files /dev/null and b/doc/salome/gui/GUI/images/plot2d_view_settings.png differ
index c2cbe5c5a72c6c44fa8a66893e152db2aa23ff06..3d4f43ce0966dddb179e1529fb0ad65aca447d32 100644 (file)
@@ -23,6 +23,7 @@
 <ul>
 <li>\ref occ_3d_viewer_page</li>
 <li>\ref vtk_3d_viewer_page</li>
+<li>\ref plot2d_viewer_page</li>
 </ul>
 <li>\subpage setting_preferences_page</li>
 <ul>
@@ -35,4 +36,4 @@
 </ul>
 </ul>
 
-*/
\ No newline at end of file
+*/
index fe9d047a7655eebb6658cf2b5903c6979fd82b7e..1f340a40519f42c624c6c77bef411554f1467cfa 100644 (file)
@@ -34,6 +34,7 @@
 <ul>
 <li>\ref occ_3d_viewer_page</li>
 <li>\ref vtk_3d_viewer_page</li>
+<li>\ref plot2d_viewer_page</li>
 </ul>
 <li>\ref setting_preferences_page</li>
 <ul>
@@ -47,4 +48,4 @@
 </ul>
 
 
-*/
\ No newline at end of file
+*/
diff --git a/doc/salome/gui/GUI/input/plot2d_viewer.doc b/doc/salome/gui/GUI/input/plot2d_viewer.doc
new file mode 100644 (file)
index 0000000..e6208d6
--- /dev/null
@@ -0,0 +1,94 @@
+/*!
+
+\page plot2d_viewer_page Plot 2D viewer
+
+\n <b>Plot 2d viewer</b> is destined to the representation of  2d
+plots and graphs in Post-Pro module.
+\n Its viewer toolbar gives you fast access to the following
+operations:
+
+\image html image77.gif
+<center><b>Dump View</b> - exports an object from the viewer in bmp,
+png, jpg or jpeg image format.</center>
+
+\image html image96.gif
+<center><b>Fit all</b> - scales the display to show the entire
+scene. Use this to resize the scene so that it could fit within the
+Viewer boundary.</center>
+
+\image html image97.gif
+<center><b>Fit area</b> - resizes the view to place in the visible
+area only the contents of a frame drawn with pressed left mouse
+button.</center>
+
+\image html image98.gif
+<center><b>Zoom</b> - allows to zoom in and out.</center>
+
+\image html image99.gif
+<center>\b Panning - if the represented objects are greater that the
+visible area and you don't wish to use Fit all functionality, click on
+this button and you'll be able to drag the scene to see its remote
+parts.</center>
+
+\image html image100.gif
+<center><b>Global panning</b> - allows to define the center of the
+scene presenting all displayed objects in the visible area.</center>
+
+\image html plot2d_points.gif
+<center><b>Draw Points</b> - represents points on the graph.</center>
+
+\image html plot2d_lines.gif
+<center><b>Draw Lines</b> - represents lines on the graph.</center>
+
+\image html plot2d_splines.gif
+<center><b>Draw Splines</b> - represents splines on the graph.</center>
+
+\image html plot2d_logarithmic_horizontal.gif
+<center><b>Horizontal axis logarithmic</b> - changes the scaling on
+horizontal axis to logarithmic.</center>
+
+\image html plot2d_logarithmic_vertical.gif
+<center><b>Vertical axis logarithmic</b> - changes the scaling on vertical
+axis to logarithmic.</center>
+
+\image html plot2d_legend.gif
+<center><b>Show Legend</b> - reveals all verbal and numerical
+information on the graphs.</center>
+
+\image html plot2d_settings.gif
+<center>\b Settings - calls a menu, in which you can specify advanced
+settings for your Plot 2d Viewer.</center>
+
+\image html plot2d_clone.gif
+<center><b>Clone view</b> - opens a new duplicate scene.</center>
+
+\anchor settings
+\n \image html plot2d_view_settings.png
+
+The options are as follows:
+<ul>
+<li><b>Main title:</b> the title of the XY plot. By default, it will
+consist of the names of the tables, on the basis of which the curve
+lines have been constructed.</li>
+<li><b>Curve type:</b> you can select from \b Points, \b Lines and \b Spline.</li>
+<li><b>Show legend:</b> here you can define the position of the
+description table on the XY plot (to the \b Left, to the \b Right, on
+\b Top or on \b Bottom).</li>
+<li><b>Marker size</b> - size of the points (markers) forming curve lines.</li>
+<li><b>Background color</b> of the XY plot.</li>
+<li><b>Scale mode:</b> here you can select the type of scaling (\b
+Linear or \b Logarithmic) along <b>X (Horizontal)</b> or <b>Y (Vertical)</b> axes.</li>
+</ul>
+
+You can define settings for each axis separately:
+<ul>
+<li>\b Horizontal or \b Vertical axis title.</li>
+<li><b>Grid/Axes marks:</b>  here you can define the maximum number of major
+and minor scale divisions for a specified axis. The real number of
+intervals fits to {1,2,5}*10^N, where N is a natural number, and
+doesn't exceed the maximum.</li>
+<li><b>Save settings as default:</b> If this check box is marked, all
+XY plots will be displayed with these defined properties.</li>
+</ul>
+
+*/
index b13b5cf57772c03adbb0c25bbef92ec9a42250ce..44271fcf11df8502c6f15a47010a58e8ac8b838d 100644 (file)
@@ -5,6 +5,7 @@
 <ul>
 <li>\subpage occ_3d_viewer_page</li>
 <li>\subpage vtk_3d_viewer_page</li>
+<li>\subpage plot2d_viewer_page</li>
 </ul>
 
-*/
\ No newline at end of file
+*/
index 9f1b2f03a869b2af60eb1b160d9dffb3bcff329d..e8c8b54c10ce16f92d9d9c705a88cb2382d9d542 100755 (executable)
@@ -23,6 +23,9 @@
 
 #include "Plot2d_SetupViewDlg.h"
 
+#include "SUIT_Session.h"
+#include "SUIT_Application.h"
+
 #include <qcheckbox.h>
 #include <qlineedit.h>
 #include <qcombobox.h>
@@ -247,16 +250,20 @@ Plot2d_SetupViewDlg::Plot2d_SetupViewDlg( QWidget* parent, bool showDefCheck, bo
   aTabWidget->setCurrentPage( 0 );
   /* "Set as default" check box */
   myDefCheck = new QCheckBox( tr( "PLOT2D_SET_AS_DEFAULT_CHECK" ), this );
-  /* OK/Cancel buttons */
+
+  /* OK/Cancel/Help buttons */
   myOkBtn = new QPushButton( tr( "BUT_OK" ), this );
   myOkBtn->setAutoDefault( TRUE );
   myOkBtn->setDefault( TRUE );
   myCancelBtn = new QPushButton( tr( "BUT_CANCEL" ), this );
   myCancelBtn->setAutoDefault( TRUE );
+  myHelpBtn = new QPushButton( tr( "BUT_HELP" ), this );
+  myHelpBtn->setAutoDefault( TRUE );
   QHBoxLayout* btnLayout = new QHBoxLayout;
   btnLayout->addWidget( myOkBtn );
   btnLayout->addStretch();
   btnLayout->addWidget( myCancelBtn );
+  btnLayout->addWidget( myHelpBtn );
   
   // layout widgets
   topLayout->addWidget( myTitleCheck,          0,    0    );
@@ -293,6 +300,7 @@ Plot2d_SetupViewDlg::Plot2d_SetupViewDlg( QWidget* parent, bool showDefCheck, bo
 
   connect( myOkBtn,         SIGNAL( clicked() ), this, SLOT( accept() ) );
   connect( myCancelBtn,     SIGNAL( clicked() ), this, SLOT( reject() ) );
+  connect( myHelpBtn,       SIGNAL( clicked() ), this, SLOT( onHelp() ) );
   
   if (mySecondAxisY) {
     connect( myTitleY2Check,   SIGNAL( clicked() ), this, SLOT( onY2TitleChecked() ) );
@@ -681,3 +689,13 @@ bool Plot2d_SetupViewDlg::isSetAsDefault()
 {
   return myDefCheck->isChecked();
 }
+
+/*!
+  Slot, called when user clicks "Help" button
+*/
+void Plot2d_SetupViewDlg::onHelp()
+{
+  SUIT_Application* app = SUIT_Session::session()->activeApplication();
+  if (app)
+    app->onHelpContextModule("GUI", "plot2d_viewer_page.html#settings");
+}
index 37db3d6414cd8c4588a3c336ef269ccee098565e..d04623a8b37e814e4441fe24462f0ef62806ff23 100755 (executable)
@@ -84,6 +84,7 @@ protected slots:
   void   onXGridMinorChecked();
   void   onYGridMinorChecked();
   void   onY2GridMinorChecked();
+  void   onHelp();
 
 private:
   QCheckBox*     myTitleCheck;
@@ -118,6 +119,7 @@ private:
 
   QPushButton*   myOkBtn;
   QPushButton*   myCancelBtn;
+  QPushButton*   myHelpBtn;
   bool           mySecondAxisY;
 };
 
index 4210140564d2290a8efd1fb52130c8b937f8cf34..3281323e0bd45c4b84dcc04c99176cf35db15ed7 100755 (executable)
@@ -636,3 +636,12 @@ void SUIT_Application::onDesktopActivated()
 {
   emit activated( this );
 }
+
+/*!
+  SLOT: is used for Help browsing
+*/
+
+void SUIT_Application::onHelpContextModule (const QString& /*theComponentName*/,
+                                            const QString& /*theFileName*/)
+{
+}
index b6d69edca073efab8493fa62710a2dfc2a4f74dd..151877d675ba87448e6697119fc6f0235ba8d47b 100755 (executable)
@@ -116,6 +116,7 @@ signals:
 
 public slots:
   virtual void          updateCommandsStatus();
+  virtual void          onHelpContextModule( const QString&, const QString& );
 
 private slots:
   void                  onInfoClear();