[Adonthell-commits] CVS: adonthell/src/tools/dlgedit dlg_arrow.h,1.3,1.4 dlg_cmdline.cc,1.3,1.4 dlg_mover.cc,1.2,1.3 dlg_mover.h,1.2,1.3 gui_circle.cc,1.3,1.4 gui_code.cc,1.3,1.4 gui_edit.h,1.2,1.3 gui_graph.h,1.4,1.5

[Kai Sterker <address@hidden>]

Update of /cvsroot/adonthell/adonthell/src/tools/dlgedit
In directory subversions:/tmp/cvs-serv9471

Modified Files:
        dlg_arrow.h dlg_cmdline.cc dlg_mover.cc dlg_mover.h 
        gui_circle.cc gui_code.cc gui_edit.h gui_graph.h 
Log Message:
UPDATES and FIXES to the inline documentation

Index: dlg_arrow.h
===================================================================
RCS file: /cvsroot/adonthell/adonthell/src/tools/dlgedit/dlg_arrow.h,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** dlg_arrow.h 1 Jul 2002 13:53:59 -0000       1.3
--- dlg_arrow.h 13 Oct 2002 20:37:45 -0000      1.4
***************
*** 27,31 ****
  
  /**
!  * This node types' sole purpose is to link any two DlgCircles.
   * It's graphical representation is an arrow, hence the name.  
   */
--- 27,31 ----
  
  /**
!  * This node type's sole purpose is to link any two DlgCircles.
   * It's graphical representation is an arrow, hence the name.  
   */
***************
*** 33,36 ****
--- 33,39 ----
  {
  public:
+     /**
+      * Create a new arrow.
+      */
      DlgArrow () { mode_ = IDLE; type_ = LINK; }
      /**
***************
*** 80,84 ****
--- 83,96 ----
      bool operator== (DlgPoint &point);
      
+     /**
+      * Get the arrow's head.
+      * @return position of the arrow's head.
+      */
      DlgPoint getTip ()      { return DlgPoint (line[1]); }
+     
+     /**
+      * Get the arrow's tail.
+      * @return position of the arrow's tail.
+      */
      DlgPoint getTail ()     { return DlgPoint (line[0]); }
      

Index: dlg_cmdline.cc
===================================================================
RCS file: /cvsroot/adonthell/adonthell/src/tools/dlgedit/dlg_cmdline.cc,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** dlg_cmdline.cc      17 Apr 2002 10:01:17 -0000      1.3
--- dlg_cmdline.cc      13 Oct 2002 20:37:45 -0000      1.4
***************
*** 83,87 ****
                  if (!mydir) 
                  {
!                     cerr << "Cannot open directory " << datadir << "!" << 
endl;
                      return false;
                  }
--- 83,87 ----
                  if (!mydir) 
                  {
!                     cerr << "No such directory " << datadir << "!" << endl;
                      return false;
                  }

Index: dlg_mover.cc
===================================================================
RCS file: /cvsroot/adonthell/adonthell/src/tools/dlgedit/dlg_mover.cc,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** dlg_mover.cc        7 Apr 2002 09:51:28 -0000       1.2
--- dlg_mover.cc        13 Oct 2002 20:37:45 -0000      1.3
***************
*** 14,18 ****
  
  /** 
!  * @file dlg_mover.h
   *
   * @author Kai Sterker
--- 14,18 ----
  
  /** 
!  * @file dlg_mover.cc
   *
   * @author Kai Sterker

Index: dlg_mover.h
===================================================================
RCS file: /cvsroot/adonthell/adonthell/src/tools/dlgedit/dlg_mover.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** dlg_mover.h 7 Apr 2002 09:51:28 -0000       1.2
--- dlg_mover.h 13 Oct 2002 20:37:45 -0000      1.3
***************
*** 28,32 ****
  /**
   * Arrows have to be connected to two nodes, so to drag them from one
!  * Circle to another, it needs to be connected to an (invisble) mover.
   */
  class DlgMover : public DlgNode
--- 28,32 ----
  /**
   * Arrows have to be connected to two nodes, so to drag them from one
!  * Circle to another, they have to be connected to an (invisble) mover.
   */
  class DlgMover : public DlgNode

Index: gui_circle.cc
===================================================================
RCS file: /cvsroot/adonthell/adonthell/src/tools/dlgedit/gui_circle.cc,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** gui_circle.cc       25 Jun 2002 16:25:52 -0000      1.3
--- gui_circle.cc       13 Oct 2002 20:37:45 -0000      1.4
***************
*** 18,22 ****
  
  /**
!  * @file gui_circle.h
   *
   * @author Kai Sterker
--- 18,22 ----
  
  /**
!  * @file gui_circle.cc
   *
   * @author Kai Sterker

Index: gui_code.cc
===================================================================
RCS file: /cvsroot/adonthell/adonthell/src/tools/dlgedit/gui_code.cc,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** gui_code.cc 12 Oct 2002 18:51:33 -0000      1.3
--- gui_code.cc 13 Oct 2002 20:37:45 -0000      1.4
***************
*** 18,22 ****
  
  /**
!  * @file gui_code.h
   *
   * @author Kai Sterker
--- 18,22 ----
  
  /**
!  * @file gui_code.cc
   *
   * @author Kai Sterker

Index: gui_edit.h
===================================================================
RCS file: /cvsroot/adonthell/adonthell/src/tools/dlgedit/gui_edit.h,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** gui_edit.h  7 Apr 2002 09:51:28 -0000       1.2
--- gui_edit.h  13 Oct 2002 20:37:45 -0000      1.3
***************
*** 17,21 ****
   *
   * @author Kai Sterker
!  * @brief Wrapper around the gtkeditor widget.
   */
  
--- 17,21 ----
   *
   * @author Kai Sterker
!  * @brief Wrapper around the GtkText widget.
   */
  
***************
*** 25,30 ****
  
  /**
!  * The gtkeditor widget is a custom textbox widget with syntax-highlighting
!  * abilities. This class provides the gtkeditor widget with Python support.
   */
  class GuiEdit
--- 25,30 ----
  
  /**
!  * Provides a simple C++ interface to GtkText. The widget is initialised
!  * to use a font with fixed width, so it should only be used to edit code.
   */
  class GuiEdit
***************
*** 32,36 ****
  public:
      /**
!      * Create a new editor widget with Python syntax highlighting.
       * @param container Container to put the editor widget into.
       */
--- 32,36 ----
  public:
      /**
!      * Create a new GtkText widget.
       * @param container Container to put the editor widget into.
       */
***************
*** 39,43 ****
  
      /**
!      * Get a pointer to the editor widget.
       * @return a pointer to the editor widget.
       */
--- 39,43 ----
  
      /**
!      * Get a pointer to the GtkText widget.
       * @return a pointer to the editor widget.
       */

Index: gui_graph.h
===================================================================
RCS file: /cvsroot/adonthell/adonthell/src/tools/dlgedit/gui_graph.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** gui_graph.h 12 Oct 2002 18:51:33 -0000      1.4
--- gui_graph.h 13 Oct 2002 20:37:45 -0000      1.5
***************
*** 176,181 ****
--- 176,200 ----
       */
      //@{
+     /**
+      * Prepare a DlgNode for dragging. Circles can be moved directly.
+      * Arrows need to be attached to a temporary, invisible node. This
+      * method takes care of that.
+      * @param point position where the user started to drag the mouse.
+      * @return <b>true</b> if a node is being dragged, <b>false</b> otherwise.
+      */
      bool prepareDragging (DlgPoint &point);
+     /**
+      * As long as in dragging mode, this method will update the position
+      * of the node being dragged.
+      * @param point current cursor position.
+      */
      void drag (DlgPoint &point);
+     /**
+      * Once the user releases the left mouse button, this method calculates
+      * the final position. In case of an Arrow being dragged, it will be
+      * attached to a node if possible. Otherwise, the former state will be
+      * restored.
+      * @param point current cursor position. 
+      */
      void stopDragging (DlgPoint &point);
      //@}