Mercurial > hg > octave-nkf
changeset 14863:3ff18e21c742 gui
Added a few comments.
* files-dockwidget.h: Added comments.
* history-dockwidget.h: Added comments.
author | Jacob Dawid <jacob.dawid@gmail.com> |
---|---|
date | Mon, 16 Jul 2012 16:42:25 -0400 |
parents | 9a355dfc7701 |
children | 3a05cb67dea5 |
files | gui/src/files-dockwidget.h gui/src/history-dockwidget.h |
diffstat | 2 files changed, 19 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/gui/src/files-dockwidget.h +++ b/gui/src/files-dockwidget.h @@ -33,10 +33,15 @@ #include <QDockWidget> #include <QLineEdit> +/** + \class files_dock_widget + \brief Dock widget to display files in the current directory. + */ class files_dock_widget : public QDockWidget { Q_OBJECT public: + /** Constructs a new files_dock_widget. */ files_dock_widget (QWidget *parent = 0); public slots: @@ -45,16 +50,26 @@ /** Slot for handling the up-directory button in the toolbar. */ void do_up_directory (); + + /** Sets the current directory being displayed. */ void set_current_directory (QString currentDirectory); + + /** Accepts user input a the line edit for the current directory. */ void handle_directory_entered (); + void display_directory (QString directory); - /** Tells the widget to notice settings that are probably new. */ + /** Tells the widget to react on changed settings. */ void notice_settings (); + + /** Slot to steer changing visibility from outside. */ void handle_visibility_changed (bool visible); signals: + /** Emitted, whenever the user requested to open a file. */ void open_file (QString fileName); + + /** Emitted, whenever the currently displayed directory changed. */ void displayed_directory_changed (QString directory); /** Custom signal that tells if a user has clicke away that dock widget. */
--- a/gui/src/history-dockwidget.h +++ b/gui/src/history-dockwidget.h @@ -44,7 +44,10 @@ signals: void information (QString message); + + /** Emitted, whenever the user double-clicked a command in the history. */ void command_double_clicked (QString command); + /** Custom signal that tells if a user has clicked away that dock widget. */ void active_changed (bool active); protected: