editorbase.h

Go to the documentation of this file.

/*
 * This file is part of the Code::Blocks IDE and licensed under the GNU Lesser General Public License, version 3
 * http://www.gnu.org/licenses/lgpl-3.0.html
 */

#ifndef EDITORBASE_H
#define EDITORBASE_H

#include "prep.h"

#include <wx/hashmap.h>
#include <wx/frame.h>
#include <wx/panel.h>
#include "globals.h"
#include "settings.h"
#include "cbexception.h"

class wxMenu;
class EditorBase;
struct EditorBaseInternalData;
class cbDebuggerPlugin;

WX_DECLARE_HASH_MAP(int, EditorBase*, wxIntegerHash, wxIntegerEqual, SwitchToMap);

class DLLIMPORT EditorBase : public wxPanel
{
    DECLARE_EVENT_TABLE()
    public:
        EditorBase(wxWindow* parent, const wxString& filename);
        ~EditorBase() override;

        void operator=(cb_optional const EditorBase& rhs){ cbThrow(_T("Can't assign an EditorBase* !!!")); }

        virtual const wxString& GetFilename() const { return m_Filename; }

        virtual void SetFilename(const wxString& filename){ m_Filename = filename; }

        virtual const wxString& GetShortName() const { return m_Shortname; }

        virtual bool GetModified() const { return false; }

        virtual void SetModified(bool /*modified*/ = true) {}

        virtual const wxString& GetTitle();

        virtual void SetTitle(const wxString& newTitle);

        virtual void Activate();

        virtual bool QueryClose();

        virtual bool Close();

        virtual bool Save() { return true; }

        virtual bool SaveAs() { return true; }

        virtual bool IsBuiltinEditor() const;

        virtual bool ThereAreOthers() const;

        virtual void DisplayContextMenu(const wxPoint& position, ModuleType type = mtUnknown);

        virtual bool VisibleToTree() const { return true; }

        virtual void GotoLine(int /*line*/, bool /*centerOnScreen*/ = true){}

        virtual void Undo(){}

        virtual void Redo(){}

        virtual void ClearHistory(){}

        virtual void GotoNextChanged(){}

        virtual void GotoPreviousChanged(){}

        virtual void SetChangeCollection(cb_optional bool collectChange){}

        virtual void Cut(){}

        virtual void Copy(){}

        virtual void Paste(){}

        virtual bool CanUndo() const { return false; }

        virtual bool CanRedo() const { return false; }

        virtual bool HasSelection() const { return false; }

        virtual bool CanPaste() const { return false; }

        virtual bool IsReadOnly() const { return false; }

        virtual void SetReadOnly(bool /*readonly*/ = true) {}

        virtual bool CanSelectAll() const { return false; }

        virtual void SelectAll() { return; }

        virtual bool IsContextMenuOpened() const;
    protected:
        virtual void InitFilename(const wxString& filename);

        virtual wxMenu* CreateContextSubMenu(long id); // For context menus

        virtual void AddToContextMenu(cb_optional wxMenu* popup, cb_optional ModuleType type, cb_optional bool pluginsdone) {}

        virtual wxString CreateUniqueFilename();

        virtual bool OnBeforeBuildContextMenu(cb_optional const wxPoint& position, cb_optional ModuleType type){ return true; }

        virtual void OnAfterBuildContextMenu(cb_optional ModuleType type){}

        bool m_IsBuiltinEditor; // do not mess with it!
        wxString m_Shortname;
        wxString m_Filename;
        EditorBaseInternalData* m_pData; 
    private:
        EditorBase(cb_unused const EditorBase& rhs); // prevent copy construction

        void OnContextMenuEntry(wxCommandEvent& event);
        void BasicAddToContextMenu(wxMenu* popup, ModuleType type); //pecan 2006/03/22
        SwitchToMap m_SwitchTo;
        wxString m_WinTitle;
        wxString lastWord;
};

#endif // EDITORBASE_H