[rkward-cvs] SF.net SVN: rkward: [902] trunk/rkward/rkward/windows/rkcommandeditorwindow .h

[tfry at users.sourceforge.net]

Revision: 902
          http://svn.sourceforge.net/rkward/?rev=902&view=rev
Author:   tfry
Date:     2006-10-30 04:52:42 -0800 (Mon, 30 Oct 2006)

Log Message:
-----------
some API documentation

Modified Paths:
--------------
    trunk/rkward/rkward/windows/rkcommandeditorwindow.h

Modified: trunk/rkward/rkward/windows/rkcommandeditorwindow.h
===================================================================
--- trunk/rkward/rkward/windows/rkcommandeditorwindow.h	2006-10-30 12:32:25 UTC (rev 901)
+++ trunk/rkward/rkward/windows/rkcommandeditorwindow.h	2006-10-30 12:52:42 UTC (rev 902)
@@ -35,6 +35,10 @@
 	RKScriptContextProvider () {};
 	~RKScriptContextProvider () {};
 
+	/** to be implemented in subclasses. Provide some context (probably a line, but you may provide chunks in arbitrary size). If line_rev is 0, provide the line, the cursor is in. If line_rev is greater than 0, provide context before that.
+	@param context Place the context here
+	@param cursor_position if line_rev is 0, set this to the current column of the cursor, else set to -1
+	@returns whether context was available or not */
 	virtual bool provideContext (unsigned int line_rev, QString *context, int *cursor_position) = 0;
 };
 
@@ -45,12 +49,16 @@
 	RKFunctionArgHinter (RKScriptContextProvider *provider, Kate::View* view);
 	~RKFunctionArgHinter ();
 
+	/** Try to show an arg hint now */
 	void tryArgHint ();
+	/** Hide the arg hint (if shown) */
 	void hideArgHint ();
 public slots:
+	/** Internal worker function for tryArgHint () */
 	void tryArgHintNow ();
 protected:
-	bool eventFilter (QObject *o, QEvent *e);
+	/** The (keypress) events of the view are filtered to determine, when to show / hide an argument hint */
+	bool eventFilter (QObject *, QEvent *e);
 private:
 	RKScriptContextProvider *provider;
 	Kate::View *view;


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.