summaryrefslogtreecommitdiff
authoribotty <ibotty>2002-10-08 11:58:01 (UTC)
committer ibotty <ibotty>2002-10-08 11:58:01 (UTC)
commit527227e2065d70887d7de94169434b491a83e5ba (patch) (side-by-side diff)
tree20a981f13032d67a3be51a14aa2ef7a83423a5b1
parent21766cbcf4b4ca84da82a83f1b87d1366e75dd86 (diff)
downloadopie-527227e2065d70887d7de94169434b491a83e5ba.zip
opie-527227e2065d70887d7de94169434b491a83e5ba.tar.gz
opie-527227e2065d70887d7de94169434b491a83e5ba.tar.bz2
updated documentation
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--noncore/apps/opie-console/widget_layer.h32
1 files changed, 26 insertions, 6 deletions
diff --git a/noncore/apps/opie-console/widget_layer.h b/noncore/apps/opie-console/widget_layer.h
index adf2038..d821f1d 100644
--- a/noncore/apps/opie-console/widget_layer.h
+++ b/noncore/apps/opie-console/widget_layer.h
@@ -39,52 +39,61 @@ class WidgetLayer : public QFrame
{ Q_OBJECT
public:
/**
* constructor
+ * @param const Profile &config, the configuration for this widget
+ * @param QWidget *parent, the parent widget
+ * @param const char *name, the name of the widget, defaults to ""
*/
- WidgetLayer( QWidget *parent=0, const char *name=0 );
+ WidgetLayer( const Profile &config, QWidget *parent=0, const char *name=0 );
/**
* destructor
*/
virtual ~WidgetLayer();
public:
/**
* sets the image
+ * @param QArray<Character> const newimg, the new image
+ * @param int lines, lines count of newimg
+ * @param int columns, columns count of newimg
*/
virtual void setImage( QArray<Character> const newimg, int lines, int colums ) = 0;
/**
* annoy the user
*/
void bell();
/**
- * return the lines count
+ * @return int m_lines, the lines count
*/
int lines() { return m_lines; }
/**
- * return the columns count
+ * @return int m_columns, the columns count
*/
int columns() { return m_columns; }
/**
* insert current selection (currently this is only the clipboard)
*/
void insertSelection();
/**
* insert text
+ * @param QString text, the text to be inserted
*/
void insertText( QString text );
+
/**
* set selection (clipboard) to text
+ * @param const QString &text, the text to be selected
*/
void setSelection( const QString &text );
/**
* paste content of clipboard
*/
@@ -97,47 +106,58 @@ signals:
* key was pressed
*/
void keyPressed( QKeyEvent *e );
/**
* whenever Mouse selects something
- * 0 left Button
- * 3 Button released
+ * @param int button, the button that us pressed :
+ * 0 left Button
+ * 3 Button released
+ * @param int x, x position
+ * @param int y, y position
+ *
* // numbering due to layout in old TEWidget
*/
void mousePressed( int button, int x, int y );
/**
* size of image changed
+ * @param int lines, line count of new size
+ * @param int columns, column count of new size
*/
void imageSizeChanged( int lines, int columns );
/**
* cursor in history changed
+ * @param int value, value of history cursor
*/
void historyCursorChanged( int value );
/**
* selection should be cleared
*/
void selectionCleared();
/**
* selection begin
+ * @param const int x, x position
+ * @param const int y, y position
*/
void selectionBegin( const int x, const int y );
/**
* selection extended
* (from begin (s.a.) to x, y)
+ * @param const int x, x position
+ * @param const int y, y position
*/
void selectionExtended( const int x, const int y );
/**
* selection end
- * bool: preserve line breaks in selection
+ * @param const bool lineBreakPreserve, preserve line breaks in selection
*/
void selectionEnd( const bool lineBreakPreserve );
// protected methods