file-editor-interface.h

Go to the documentation of this file.

/*

Copyright (C) 2011-2018 Jacob Dawid

This file is part of Octave.

Octave 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.

Octave 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 Octave; see the file COPYING.  If not, see
<https://www.gnu.org/licenses/>.

*/

#if ! defined (octave_file_editor_interface_h)
#define octave_file_editor_interface_h 1

#include <QMenu>
#include <QToolBar>
#include <QSettings>
#include "octave-dock-widget.h"

namespace octave
{
  class file_editor_interface : public octave_dock_widget
  {
    Q_OBJECT

  public:

    file_editor_interface (QWidget *p)
      : octave_dock_widget (p)
    {
      setObjectName ("FileEditor");
    }

    virtual ~file_editor_interface (void) = default;

    virtual QMenu * get_mru_menu (void) = 0;
    virtual QMenu * debug_menu (void) = 0;
    virtual QToolBar * toolbar (void) = 0;

    virtual void insert_global_actions (QList<QAction*>) = 0;
    virtual void handle_enter_debug_mode (void) = 0;
    virtual void handle_exit_debug_mode (void) = 0;

    virtual void
    handle_insert_debugger_pointer_request (const QString& file, int line) = 0;

    virtual void
    handle_delete_debugger_pointer_request (const QString& file, int line) = 0;

    virtual void
    handle_update_breakpoint_marker_request (bool insert, const QString& file,
                                             int line, const QString& cond) = 0;

    virtual void handle_edit_file_request (const QString& file) = 0;

    virtual bool check_closing (void) = 0;

    virtual void empty_script (bool, bool) = 0;

    virtual void restore_session (QSettings *) = 0;

    virtual void enable_menu_shortcuts (bool enable) = 0;

  public slots:

    virtual void request_new_file (const QString& command = QString ()) = 0;

    virtual void request_open_file (const QString& openFileName,
                                    const QString& encoding = QString (),
                                    int line = -1,
                                    bool debug_pointer = false,
                                    bool breakpoint_marker = false,
                                    bool insert = true,
                                    const QString& cond = "") = 0;
  };
}

#endif