Changeset 13400

Timestamp:

2012-10-16T10:49:20+02:00 (12 years ago)

Author:

hkiel

Message:

# 1836

• added history of documentation viewer and backward/forward buttons to navigate

Location:

trunk/OMEdit

Files:

• OMEditGUI/DocumentationWidget.cpp (modified) (12 diffs)
• OMEditGUI/DocumentationWidget.h (modified) (2 diffs)
• OMEditGUI/LibraryWidget.cpp (modified) (1 diff)
• OMEditGUI/ProjectTabWidget.cpp (modified) (2 diffs)
• README.txt (modified) (1 diff)

trunk/OMEdit/OMEditGUI/DocumentationWidget.cpp

@@ -50 +50 @@
   mpDocumentationViewer = new DocumentationViewer(this);
   mpDocumentationEditor = new DocumentationEditor(this);
-  setIsCustomModel(false);
+  mpUrlHistory = new QList<UrlSrc>();
+  mUrlHistoryPos = -1;
   mpHeadingLabel = new QPlainTextEdit;
   mpHeadingLabel->setObjectName("DocumentationLabel");
@@ -64 +65 @@
   mpEditButton->setAutoDefault(true);
   mpEditButton->setMaximumSize(QSize(120,20));
+  mpEditButton->setVisible(false);
   connect(mpEditButton, SIGNAL(clicked()), SLOT(editDocumentation()));
   mpSaveButton = new QPushButton(Helper::save);
   mpSaveButton->setAutoDefault(false);
   mpSaveButton->setMaximumSize(QSize(100,20));
+  mpSaveButton->setVisible(false);
   connect(mpSaveButton, SIGNAL(clicked()), SLOT(saveChanges()));
+  mpBackButton = new QPushButton(Helper::backwardBrush);
+  mpBackButton->setAutoDefault(false);
+  mpBackButton->setMaximumSize(QSize(120,20));
+  mpBackButton->setVisible(false);
+  connect(mpBackButton, SIGNAL(clicked()), SLOT(back()));
+  mpForwardButton = new QPushButton(Helper::forwardBrush);
+  mpForwardButton->setAutoDefault(false);
+  mpForwardButton->setMaximumSize(QSize(120,20));
+  mpForwardButton->setVisible(false);
+  connect(mpForwardButton, SIGNAL(clicked()), SLOT(forward()));
   QHBoxLayout *horizontalLayout = new QHBoxLayout;
   horizontalLayout->setAlignment(Qt::AlignTop | Qt::AlignLeft);
   horizontalLayout->addWidget(mpPixmapLabel);
   horizontalLayout->addWidget(mpHeadingLabel);
-  horizontalLayout->addWidget(mpSaveButton);
-  horizontalLayout->addWidget(mpEditButton);
+  QHBoxLayout *horizontalLayout2 = new QHBoxLayout;
+  horizontalLayout2->setAlignment(Qt::AlignTop | Qt::AlignLeft);
+  horizontalLayout2->addWidget(mpBackButton);
+  horizontalLayout2->addWidget(mpForwardButton);
+  QHBoxLayout *horizontalLayout3 = new QHBoxLayout;
+  horizontalLayout3->setAlignment(Qt::AlignTop | Qt::AlignLeft);
+  horizontalLayout3->addWidget(mpSaveButton);
+  horizontalLayout3->addWidget(mpEditButton);
   // set layout
   QVBoxLayout *verticalLayout = new QVBoxLayout;
   verticalLayout->setAlignment(Qt::AlignTop | Qt::AlignLeft);
   verticalLayout->addLayout(horizontalLayout);
-  verticalLayout->addWidget(mpDocumentationViewer);
-  verticalLayout->addWidget(mpDocumentationEditor);
+  verticalLayout->addLayout(horizontalLayout2);
+  verticalLayout->addLayout(horizontalLayout3);
+  verticalLayout->addWidget(mpDocumentationViewer,1);
+  verticalLayout->addWidget(mpDocumentationEditor,1);
   setLayout(verticalLayout);
+  mpDocumentationViewer->setVisible(false);
+  mpDocumentationEditor->setVisible(false);
+  mpPixmapLabel->setVisible(false);
 }
 
@@ -94 +118 @@
 //! Shows the documentation of a model
 //! @param className the model name
-void DocumentationWidget::show(QString className)
+void DocumentationWidget::show(QString className, bool isCustomModel)
 {
   mClassName = className;
@@ -110 +134 @@
   }
   // show edit and save buttons if show is called for a custom model
-  if (isCustomModel())
+  if (isCustomModel)
   {
     mpEditButton->setVisible(true);
-    mpEditButton->setDisabled(false);
+    //mpEditButton->setDisabled(false);
+    mpEditButton->setText(Helper::edit);
     mpSaveButton->setVisible(true);
     mpSaveButton->setDisabled(true);
@@ -135 +160 @@
   mDocumentationFile.close();
 
+  if ((mUrlHistoryPos >= 0) && (className == mpUrlHistory->at(mUrlHistoryPos).url))
+  {
+    /* reload url */
+  }
+  else
+  {
+    /* new url */
+    /* remove all following urls */
+    while (mpUrlHistory->count() > (mUrlHistoryPos+1))
+    {
+      mpUrlHistory->removeLast();
+    }
+    /* append new url */
+    mpUrlHistory->append(UrlSrc(className, isCustomModel));
+    mUrlHistoryPos++;
+  }
+  if (mUrlHistoryPos > 0)
+  {
+      mpBackButton->setDisabled(false);
+  }
+  else
+  {
+      mpBackButton->setDisabled(true);
+  }
+  if (mpUrlHistory->count() == (mUrlHistoryPos+1))
+  {
+      mpForwardButton->setDisabled(true);
+  }
+  else
+  {
+      mpForwardButton->setDisabled(false);
+  }
+
   mpDocumentationViewer->setUrl(mDocumentationFile.fileName());
   mpDocumentationViewer->setVisible(true);
-  mpDocumentationEditor->setVisible(false);
+  mpBackButton->setVisible(true);
+  mpForwardButton->setVisible(true);
+
+  mpDocumentationEditor->hide();
 }
 
@@ -146 +207 @@
   mpDocumentationViewer->hide();
   // get the already existing documentation text of the model
-  mpDocumentationEditor->toPlainText();
-  if (!mpParentMainWindow->mpOMCProxy->getDocumentationAnnotation(className).isEmpty())
-    mpDocumentationEditor->setPlainText(mpParentMainWindow->mpOMCProxy->getDocumentationAnnotation(className));
+  QString doc = mpParentMainWindow->mpOMCProxy->getDocumentationAnnotation(className);
+  if (!doc.isEmpty())
+    mpDocumentationEditor->setPlainText(doc);
   else
     mpDocumentationEditor->setPlainText("<html>\n\n</html>");
   mpDocumentationEditor->setFocus();
   mpDocumentationEditor->show();
-}
-
-//! Sets the model as custom model.
-//! @param isCustomModel
-void DocumentationWidget::setIsCustomModel(bool isCustomModel)
-{
-  mIsCustomModel = isCustomModel;
-}
-
-//! Returns true if the model is a custom model.
-//! @return bool true if model is a custom model
-bool DocumentationWidget::isCustomModel()
-{
-  return mIsCustomModel;
 }
 
@@ -183 +230 @@
 void DocumentationWidget::editDocumentation()
 {
-  showDocumentationEditView(mClassName);
-  mpEditButton->setDisabled(true);
-  mpSaveButton->setDisabled(false);
+  if (mpSaveButton->isEnabled() == false)
+  {
+    showDocumentationEditView(mClassName);
+    //mpEditButton->setDisabled(true);
+    mpEditButton->setText(Helper::cancel);
+    mpSaveButton->setDisabled(false);
+    mpBackButton->setDisabled(true);
+    mpForwardButton->setDisabled(true);
+  }
+  else
+  {
+    show(mClassName,true);
+  }
 }
 
@@ -195 +252 @@
   {
     mpParentMainWindow->mpOMCProxy->addClassAnnotation(mClassName,"annotate=Documentation(info = \""+StringHandler::escape(doc)+"\")");
-    show(mClassName);
+    show(mClassName,true);
   }
   else
@@ -202 +259 @@
     mpParentMainWindow->mpMessageWidget->addGUIProblem(new ProblemItem("", false, 0, 0, 0, 0, message, Helper::scriptingKind,
                                                                        Helper::errorLevel, 0, mpParentMainWindow->mpMessageWidget->mpProblem));
+  }
+}
+
+//! Go to previous document
+void DocumentationWidget::back()
+{
+  if (mUrlHistoryPos > 0)
+  {
+      mUrlHistoryPos--;
+      show(mpUrlHistory->at(mUrlHistoryPos).url,mpUrlHistory->at(mUrlHistoryPos).isCustomModel);
+  }
+}
+
+//! Go to next document
+void DocumentationWidget::forward()
+{
+  if ((mUrlHistoryPos+1) < mpUrlHistory->count())
+  {
+      mUrlHistoryPos++;
+      show(mpUrlHistory->at(mUrlHistoryPos).url,mpUrlHistory->at(mUrlHistoryPos).isCustomModel);
   }
 }
@@ -266 +343 @@
     className = url.toString().mid(10, url.toString().length() - 1);
     // send the new className to DocumentationWidget
-    mpParentDocumentationWidget->show(className);
+    mpParentDocumentationWidget->show(className, false);
   }
   // if it is normal http request then check if its not redirected to https
@@ -325 +402 @@
 {
     Q_UNUSED(type);
- 
+
     QWebView *webView = new QWebView;
     QWebPage *newWeb = new QWebPage(webView);
@@ -331 +408 @@
     webView->setPage(newWeb);
     webView->show();
- 
+
     return webView;
 }

trunk/OMEdit/OMEditGUI/DocumentationWidget.h

@@ -47 +47 @@
 class DocumentationEditor;
 
+class UrlSrc
+{
+public:
+    QString url;
+    bool    isCustomModel;
+
+    UrlSrc(QString u, bool i){url = u; isCustomModel = i;}
+};
+
 class DocumentationWidget : public QWidget
 {
   Q_OBJECT
 private:
-  bool mIsCustomModel;
+  QList<UrlSrc> * mpUrlHistory;
+  int mUrlHistoryPos;
 public slots:
   void editDocumentation();
   void saveChanges();
+  void back();
+  void forward();
 public:
   DocumentationWidget(MainWindow *pParent);
   ~DocumentationWidget();
-  void show(QString className);
+  void show(QString className, bool isCustomModel);
   void showDocumentationEditView(QString className);
-  void setIsCustomModel(bool isCustomModel);
-  bool isCustomModel();
 
   MainWindow *mpParentMainWindow;
@@ -70 +80 @@
   QPushButton *mpEditButton;
   QPushButton *mpSaveButton;
+  QPushButton *mpForwardButton;
+  QPushButton *mpBackButton;
   QDialogButtonBox *mpButtonBox;
   QFile mDocumentationFile;

trunk/OMEdit/OMEditGUI/LibraryWidget.cpp

@@ -875 +875 @@
   pMainWindow->mpDocumentationDockWidget->show();
   LibraryTreeNode *pItem = dynamic_cast<LibraryTreeNode*>(mpParentLibraryWidget->mSelectedLibraryNode);
-  pMainWindow->mpDocumentationWidget->setIsCustomModel(false);
-  pMainWindow->mpDocumentationWidget->show(pItem->mNameStructure);
+  pMainWindow->mpDocumentationWidget->show(pItem->mNameStructure,false);
 }
 

trunk/OMEdit/OMEditGUI/ProjectTabWidget.cpp

@@ -888 +888 @@
 
 void GraphicsView::createBitmapShape(QPointF point)
-{       
+{
   if (mpParentProjectTab->isReadOnly())
     return;
@@ -1744 +1744 @@
 {
   mpParentProjectTabWidget->mpParentMainWindow->mpDocumentationDockWidget->show();
-  mpParentProjectTabWidget->mpParentMainWindow->mpDocumentationWidget->setIsCustomModel(true);
-  mpParentProjectTabWidget->mpParentMainWindow->mpDocumentationWidget->show(mModelNameStructure);
+  mpParentProjectTabWidget->mpParentMainWindow->mpDocumentationWidget->show(mModelNameStructure,true);
 }
 

trunk/OMEdit/README.txt

@@ -23 +23 @@
   - Load the file OMEditGUI/OMEditGUI.pro in Qt Creator IDE. Qt Creator is included in Qt SDK.
   - Build and run the project.
-  - Copy omniORB416_rt.dll, omniORB416_rtd.dll, omnithread34_rt.dll and omnithread34_rtd.dll from c:/OMDev/omniORB-4.1.6-mingw/bin/x86_win32 to /location-where-OMEdit.exe-is-created.
-  - Copy qwt5.dll and qwtd5.dll from c:/OMDev/qwt-5.2.1-mingw/lib to /location-where-OMEdit.exe-is-created.
+  - Copy omniORB416_rt.dll, omniORB416_rtd.dll, omnithread34_rt.dll and omnithread34_rtd.dll from c:/OMDev/lib/omniORB-4.1.6-mingw/bin/x86_win32 to /location-where-OMEdit.exe-is-created.
+  - Copy qwt5.dll and qwtd5.dll from c:/OMDev/lib/qwt-5.2.1-mingw/lib to /location-where-OMEdit.exe-is-created.
 
 Linux