Mercurial > hg > octave-nkf

comparison gui/src/files-dockwidget.h @ 14863:3ff18e21c742 gui

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 625be3eb27c5
children
comparison
equal deleted inserted replaced
14845:9a355dfc7701 14863:3ff18e21c742
31 #include <QTreeView> 31 #include <QTreeView>
32 32
33 #include <QDockWidget> 33 #include <QDockWidget>
34 #include <QLineEdit> 34 #include <QLineEdit>
35 35
36 /**
37 \class files_dock_widget
38 \brief Dock widget to display files in the current directory.
39 */
36 class files_dock_widget : public QDockWidget 40 class files_dock_widget : public QDockWidget
37 { 41 {
38 Q_OBJECT 42 Q_OBJECT
39 public: 43 public:
44 /** Constructs a new files_dock_widget. */
40 files_dock_widget (QWidget *parent = 0); 45 files_dock_widget (QWidget *parent = 0);
41 46
42 public slots: 47 public slots:
43 /** Slot for handling a change in directory via double click. */ 48 /** Slot for handling a change in directory via double click. */
44 void item_double_clicked (const QModelIndex & index); 49 void item_double_clicked (const QModelIndex & index);
45 50
46 /** Slot for handling the up-directory button in the toolbar. */ 51 /** Slot for handling the up-directory button in the toolbar. */
47 void do_up_directory (); 52 void do_up_directory ();
53
54 /** Sets the current directory being displayed. */
48 void set_current_directory (QString currentDirectory); 55 void set_current_directory (QString currentDirectory);
56
57 /** Accepts user input a the line edit for the current directory. */
49 void handle_directory_entered (); 58 void handle_directory_entered ();
59
50 void display_directory (QString directory); 60 void display_directory (QString directory);
51 61
52 /** Tells the widget to notice settings that are probably new. */ 62 /** Tells the widget to react on changed settings. */
53 void notice_settings (); 63 void notice_settings ();
64
65 /** Slot to steer changing visibility from outside. */
54 void handle_visibility_changed (bool visible); 66 void handle_visibility_changed (bool visible);
55 67
56 signals: 68 signals:
69 /** Emitted, whenever the user requested to open a file. */
57 void open_file (QString fileName); 70 void open_file (QString fileName);
71
72 /** Emitted, whenever the currently displayed directory changed. */
58 void displayed_directory_changed (QString directory); 73 void displayed_directory_changed (QString directory);
59 74
60 /** Custom signal that tells if a user has clicke away that dock widget. */ 75 /** Custom signal that tells if a user has clicke away that dock widget. */
61 void active_changed (bool active); 76 void active_changed (bool active);
62 77