extensions::IDocument Class Reference

The Document Interface. More...

#include <extiface.h>

List of all members.

Public Member Functions

virtual const char * GetTitle () const=0
 Get the title of this document.
virtual const char * GetFileName () const=0
 Get the filename of this document.
virtual const char * GetCurrentScheme () const=0
 Get the name of the scheme being used (the unique name, not the friendly name).
virtual HWND GetScintillaHWND () const=0
 Get the handle of the Scintilla window (or NULL for non-text views).
virtual bool GetModified () const=0
 Is the document modified in memory?
virtual bool GetCanSave () const=0
 Can this document be saved (does it have a valid filename yet?).
virtual bool Save (const char *filename, bool setFilename)=0
 Save this file to the filename passed, optionally setting the UI filename.
virtual LRESULT SendEditorMessage (UINT msg, WPARAM wParam, LPARAM lParam)=0
 Send a message to Scintilla.
virtual LRESULT SendEditorMessage (UINT msg, WPARAM wParam, const char *strParam)=0
 Send a string format message to Scintilla.
virtual bool IsValid () const=0
 Check this document is valid.
virtual void AddEventSink (IDocumentEventSinkPtr sink)=0
 Add a document event sink.
virtual void RemoveEventSink (IDocumentEventSinkPtr sink)=0
 Remove a document event sink.
virtual FindNextResult FindNext (ISearchOptions *options)=0
 Find Next.
virtual bool Replace (ISearchOptions *options)=0
virtual int ReplaceAll (ISearchOptions *options)=0
virtual void Close (bool dontAskUserIfUnsaved)=0


Detailed Description

The Document Interface.

The document interface. This allows you to control a given document, get information about it and register for events.


Member Function Documentation

virtual bool extensions::IDocument::Replace ( ISearchOptions options  )  [pure virtual]

Replace

Remarks:
You should perform a FindNext first

virtual int extensions::IDocument::ReplaceAll ( ISearchOptions options  )  [pure virtual]

Replace All

Returns:
Replacement Count

virtual void extensions::IDocument::Close ( bool  dontAskUserIfUnsaved  )  [pure virtual]

Close this document


The documentation for this class was generated from the following file:
Generated on Sun Feb 25 22:09:00 2007 for Programmer's Notepad Extensions by  doxygen 1.5.1-p1