[rkward-cvs] rkward/rkward/windows rkhtmlwindow.h,1.1,1.2

[Thomas Friedrichsmeier]

Update of /cvsroot/rkward/rkward/rkward/windows
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv1825

Modified Files:
	rkhtmlwindow.h 
Log Message:
API documentation

Index: rkhtmlwindow.h
===================================================================
RCS file: /cvsroot/rkward/rkward/rkward/windows/rkhtmlwindow.h,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** rkhtmlwindow.h	12 Oct 2005 14:37:07 -0000	1.1
--- rkhtmlwindow.h	12 Oct 2005 14:51:20 -0000	1.2
***************
*** 38,45 ****
  	Q_OBJECT
  protected:
  	RKHTMLWindow (QWidget *parent = 0);
! 
  	virtual ~RKHTMLWindow ();
  public:
  	virtual bool openURL (const KURL &url);
  /** Reload current page.*/
--- 38,48 ----
  	Q_OBJECT
  protected:
+ /** constructor. Protected. Use derived classes instead, or derive your own class.
+ @param parent parent QWidget, usually RKGlobals::rkApp () or similar */
  	RKHTMLWindow (QWidget *parent = 0);
! /** destructor */
  	virtual ~RKHTMLWindow ();
  public:
+ /** open given URL. Returns false, if the URL is not an existing local file. Loading a non-local URL may succeed, even if this returns false! */
  	virtual bool openURL (const KURL &url);
  /** Reload current page.*/
***************
*** 54,57 ****
--- 57,61 ----
  /** Here we store the position of the scroll bar before refresh. Used to scroll to the same position after a reload */
      int scroll_position;
+ /** the KHTMLPart doing all the real work */
  	KHTMLPart * khtmlpart;
  /** update caption according to given URL */
***************
*** 62,66 ****
  	\brief RKWard output window.
  
! Used to display RKWard output.
  
  @author Thomas Friedrichsmeier
--- 66,70 ----
  	\brief RKWard output window.
  
! Specialized RKHTMLWindow used for RKWard output.
  
  @author Thomas Friedrichsmeier
***************
*** 69,74 ****
  	Q_OBJECT
  public:
  	RKOutputWindow (QWidget *parent = 0);
! 
  	~RKOutputWindow ();
  
--- 73,80 ----
  	Q_OBJECT
  public:
+ /** constructor.
+ @param parent parent QWidget, usually RKGlobals::rkApp () or similar */
  	RKOutputWindow (QWidget *parent = 0);
! /** destructor */
  	~RKOutputWindow ();
  
***************
*** 77,85 ****
--- 83,97 ----
  /** reimplemented to scroll to the bottom of the page */
  	void refresh ();
+ /** refresh output window.
+ @param show Show the window, if not currently shown (this actually means: it is created if not currently existant)
+ @param raise Raise the window (if currently shown, or show==true) */
  	static void refreshOutput (bool show, bool raise);
  
+ /** return a pointer to the current output. If there is no output window, one will be created (and shown) automatically */
  	static RKOutputWindow* getCurrentOutput ();
  public slots:
+ /** flush current output. */
  	void flushOutput ();
+ /** refresh current output. Slot Wrapper around refresh. */
  	void refreshOutput ();
  protected:
***************
*** 87,90 ****
--- 99,103 ----
  	void updateCaption (const KURL &url);
  private:
+ /** print a message "Output is empty" to the output window. Used internally, if loading output fails*/
  	void showOutputEmptyMessage ();
  
***************
*** 100,104 ****
  This class wraps a khtml part.
  
! Specialized HTML window for displaying R help pages
  
  @author Pierre Ecochard
--- 113,117 ----
  This class wraps a khtml part.
  
! Specialized HTML window for displaying R help pages.
  
  @author Pierre Ecochard
***************
*** 106,111 ****
  class RKHelpWindow : public RKHTMLWindow, public KXMLGUIClient {
  public:
  	RKHelpWindow (QWidget *parent = 0);
! 
  	~RKHelpWindow ();
  };
--- 119,126 ----
  class RKHelpWindow : public RKHTMLWindow, public KXMLGUIClient {
  public:
+ /** constructor.
+ @param parent parent QWidget, usually RKGlobals::rkApp () or similar */
  	RKHelpWindow (QWidget *parent = 0);
! /** destructor */
  	~RKHelpWindow ();
  };