Code::Blocks  SVN r11506
Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
StartHerePage Class Reference

#include <startherepage.h>

Inheritance diagram for StartHerePage:
Collaboration diagram for StartHerePage:

Public Member Functions

 StartHerePage (wxEvtHandler *owner, const RecentItemsList &projects, const RecentItemsList &files, wxWindow *parent)
 
virtual ~StartHerePage ()
 
bool LinkClicked (const wxHtmlLinkInfo &link)
 
virtual bool VisibleToTree () const
 Should this kind of editor be visible in the open files tree? More...
 
void Reload ()
 
- Public Member Functions inherited from EditorBase
 EditorBase (wxWindow *parent, const wxString &filename)
 
 ~EditorBase () override
 
void operator= (cb_optional const EditorBase &rhs)
 Don't use this. More...
 
virtual const wxStringGetFilename () const
 Get the editor's filename (if applicable). More...
 
virtual void SetFilename (const wxString &filename)
 Sets the editor's filename. More...
 
virtual const wxStringGetShortName () const
 Returns the editor's short name. More...
 
virtual bool GetModified () const
 Is it modified? More...
 
virtual void SetModified (bool=true)
 Set the modification status. More...
 
virtual const wxStringGetTitle ()
 The editor's title. More...
 
virtual void SetTitle (const wxString &newTitle)
 Set the editor's title. More...
 
virtual void Activate ()
 Activate this editor. More...
 
virtual bool QueryClose ()
 Can this be closed (destroyed)? More...
 
virtual bool Close ()
 Close this editor. More...
 
virtual bool Save ()
 Save contents. More...
 
virtual bool SaveAs ()
 Save editor contents under a different filename. More...
 
virtual bool IsBuiltinEditor () const
 Is this a built-in editor? More...
 
virtual bool ThereAreOthers () const
 Are there other editors besides this? More...
 
virtual void DisplayContextMenu (const wxPoint &position, ModuleType type=mtUnknown)
 Display context menu. More...
 
virtual void GotoLine (int, bool=true)
 Move the caret at the specified line. More...
 
virtual void Undo ()
 Undo changes. More...
 
virtual void Redo ()
 Redo changes. More...
 
virtual void ClearHistory ()
 Clear Undo- (and Changebar-) history. More...
 
virtual void GotoNextChanged ()
 Goto next changed line. More...
 
virtual void GotoPreviousChanged ()
 Goto previous changed line. More...
 
virtual void SetChangeCollection (cb_optional bool collectChange)
 Enable or disable changebar. More...
 
virtual void Cut ()
 Cut selected text/object to clipboard. More...
 
virtual void Copy ()
 Copy selected text/object to clipboard. More...
 
virtual void Paste ()
 Paste selected text/object from clipboard. More...
 
virtual bool CanUndo () const
 Is there something to undo? More...
 
virtual bool CanRedo () const
 Is there something to redo? More...
 
virtual bool HasSelection () const
 Is there a selection? More...
 
virtual bool CanPaste () const
 Is there something to paste? More...
 
virtual bool IsReadOnly () const
 Is the editor read-only? More...
 
virtual void SetReadOnly (bool=true)
 Set the editor read-only. More...
 
virtual bool CanSelectAll () const
 Can the editor select everything? More...
 
virtual void SelectAll ()
 Select everything in the editor. More...
 
virtual bool IsContextMenuOpened () const
 Is there a context (right click) menu open. More...
 

Protected Attributes

wxEvtHandlerm_pOwner
 
wxHtmlWindowm_pWin
 
wxString m_OriginalPageContent
 
const RecentItemsListm_projects
 
const RecentItemsListm_files
 
- Protected Attributes inherited from EditorBase
bool m_IsBuiltinEditor
 
wxString m_Shortname
 
wxString m_Filename
 
EditorBaseInternalDatam_pData
 Use this to add new vars/functions w/out breaking the ABI. More...
 

Private Member Functions

void RegisterColours ()
 

Private Attributes

wxString revInfo
 

Additional Inherited Members

- Protected Member Functions inherited from EditorBase
virtual void InitFilename (const wxString &filename)
 Initializes filename data. More...
 
virtual wxMenuCreateContextSubMenu (long id)
 Creates context submenus. More...
 
virtual void AddToContextMenu (cb_optional wxMenu *popup, cb_optional ModuleType type, cb_optional bool pluginsdone)
 Creates context menu items, both before and after creating plugins menu items. More...
 
virtual wxString CreateUniqueFilename ()
 Creates unique filename when asking to save the file. More...
 
virtual bool OnBeforeBuildContextMenu (cb_optional const wxPoint &position, cb_optional ModuleType type)
 Informs the editor we 're just about to create a context menu. More...
 
virtual void OnAfterBuildContextMenu (cb_optional ModuleType type)
 Informs the editor we 're done creating the context menu (just about to display it). More...
 

Detailed Description

Definition at line 19 of file startherepage.h.

Constructor & Destructor Documentation

◆ StartHerePage()

StartHerePage::StartHerePage ( wxEvtHandler owner,
const RecentItemsList projects,
const RecentItemsList files,
wxWindow parent 
)

◆ ~StartHerePage()

StartHerePage::~StartHerePage ( )
virtual

Definition at line 228 of file startherepage.cpp.

Member Function Documentation

◆ LinkClicked()

bool StartHerePage::LinkClicked ( const wxHtmlLinkInfo link)

◆ RegisterColours()

void StartHerePage::RegisterColours ( )
private

◆ Reload()

void StartHerePage::Reload ( )

◆ VisibleToTree()

virtual bool StartHerePage::VisibleToTree ( ) const
inlinevirtual

Should this kind of editor be visible in the open files tree?

There are rare cases where an editor should not be visible in the open files tree. One such example is the "Start here" page...

Returns
True if it should be visible in the open files tree, false if not.

Reimplemented from EditorBase.

Definition at line 29 of file startherepage.h.

References RegisterColours(), and Reload().

Member Data Documentation

◆ m_files

const RecentItemsList& StartHerePage::m_files
protected

Definition at line 38 of file startherepage.h.

Referenced by Reload().

◆ m_OriginalPageContent

wxString StartHerePage::m_OriginalPageContent
protected

Definition at line 36 of file startherepage.h.

Referenced by Reload(), and StartHerePage().

◆ m_pOwner

wxEvtHandler* StartHerePage::m_pOwner
protected

Definition at line 34 of file startherepage.h.

Referenced by LinkClicked().

◆ m_projects

const RecentItemsList& StartHerePage::m_projects
protected

Definition at line 37 of file startherepage.h.

Referenced by Reload().

◆ m_pWin

wxHtmlWindow* StartHerePage::m_pWin
protected

Definition at line 35 of file startherepage.h.

Referenced by Reload(), and StartHerePage().

◆ revInfo

wxString StartHerePage::revInfo
private

Definition at line 21 of file startherepage.h.

Referenced by LinkClicked(), and StartHerePage().


The documentation for this class was generated from the following files: