view gui/src/files-dockwidget.h @ 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 625be3eb27c5
children
line wrap: on
line source

/* OctaveGUI - A graphical user interface for Octave
 * Copyright (C) 2011 Jacob Dawid (jacob.dawid@googlemail.com)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef FILESDOCKWIDGET_H
#define FILESDOCKWIDGET_H

#include <QListView>
#include <QDate>
#include <QObject>
#include <QWidget>
#include <QListWidget>
#include <QFileSystemModel>
#include <QToolBar>
#include <QToolButton>
#include <QVBoxLayout>
#include <QAction>
#include <QTreeView>

#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:
  /** Slot for handling a change in directory via double click. */
  void item_double_clicked (const QModelIndex & index);

  /** 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 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. */
  void active_changed (bool active);

protected:
  void closeEvent (QCloseEvent *event);

private:
  // TODO: Add toolbar with buttons for navigating the path, creating dirs, etc

  QString           _last_current_directory;

  /** Toolbar for file and directory manipulation. */
  QToolBar *        _navigation_tool_bar;

  /** Variables for the up-directory action. */
  QIcon             _directory_icon;
  QAction *         _directory_up_action;
  QToolButton *     _up_directory_button;

  /** The file system model. */
  QFileSystemModel *_file_system_model;

  /** The file system view. */
  QTreeView *       _file_tree_view;
  QLineEdit *       _current_directory;
};

#endif // FILESDOCKWIDGET_H