summaryrefslogtreecommitdiff
Side-by-side diff
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
@@ -43,6 +43,9 @@ 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 );
/**
@@ -54,4 +57,7 @@ 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;
@@ -63,10 +69,10 @@ public:
/**
- * 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; }
@@ -79,8 +85,11 @@ public:
/**
* 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 );
@@ -101,6 +110,10 @@ signals:
/**
* 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
*/
@@ -109,4 +122,6 @@ signals:
/**
* 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 );
@@ -114,4 +129,5 @@ signals:
/**
* cursor in history changed
+ * @param int value, value of history cursor
*/
void historyCursorChanged( int value );
@@ -124,4 +140,6 @@ signals:
/**
* selection begin
+ * @param const int x, x position
+ * @param const int y, y position
*/
void selectionBegin( const int x, const int y );
@@ -130,4 +148,6 @@ signals:
* 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 );
@@ -135,5 +155,5 @@ signals:
/**
* selection end
- * bool: preserve line breaks in selection
+ * @param const bool lineBreakPreserve, preserve line breaks in selection
*/
void selectionEnd( const bool lineBreakPreserve );