wxscintilla.h

非常好用的可移植的多平台C/C++源代码编辑器

// Move caret right one character, extending rectangular selection to new caret position.
#define wxSCI_CMD_CHARRIGHTRECTEXTEND 2429

// Move caret to first position on line, extending rectangular selection to new caret position.
#define wxSCI_CMD_HOMERECTEXTEND 2430

// Move caret to before first visible character on line.
// If already there move to first character on line.
// In either case, extend rectangular selection to new caret position.
#define wxSCI_CMD_VCHOMERECTEXTEND 2431

// Move caret to last position on line, extending rectangular selection to new caret position.
#define wxSCI_CMD_LINEENDRECTEXTEND 2432

// Move caret one page up, extending rectangular selection to new caret position.
#define wxSCI_CMD_PAGEUPRECTEXTEND 2433

// Move caret one page down, extending rectangular selection to new caret position.
#define wxSCI_CMD_PAGEDOWNRECTEXTEND 2434

// Move caret to top of page, or one page up if already at top of page.
#define wxSCI_CMD_STUTTEREDPAGEUP 2435

// Move caret to top of page, or one page up if already at top of page, extending selection to new caret position.
#define wxSCI_CMD_STUTTEREDPAGEUPEXTEND 2436

// Move caret to bottom of page, or one page down if already at bottom of page.
#define wxSCI_CMD_STUTTEREDPAGEDOWN 2437

// Move caret to bottom of page, or one page down if already at bottom of page, extending selection to new caret position.
#define wxSCI_CMD_STUTTEREDPAGEDOWNEXTEND 2438

// Move caret left one word, position cursor at end of word.
#define wxSCI_CMD_WORDLEFTEND 2439

// Move caret left one word, position cursor at end of word, extending selection to new caret position.
#define wxSCI_CMD_WORDLEFTENDEXTEND 2440

// Move caret right one word, position cursor at end of word.
#define wxSCI_CMD_WORDRIGHTEND 2441

// Move caret right one word, position cursor at end of word, extending selection to new caret position.
#define wxSCI_CMD_WORDRIGHTENDEXTEND 2442


// END of generated section
//----------------------------------------------------------------------

class  ScintillaWX;                      // forward declare
class  WordList;
struct SCNotification;

#ifndef SWIG
extern WXDLLIMPEXP_SCI const wxChar* wxSCINameStr;
class  WXDLLIMPEXP_SCI wxScintilla;
class  WXDLLIMPEXP_SCI wxScintillaEvent;
#endif

//----------------------------------------------------------------------

class WXDLLIMPEXP_SCI wxScintilla : public wxControl {
public:

#ifdef SWIG
    %pythonAppend wxScintilla   "self._setOORInfo(self)"
    %pythonAppend wxScintilla() ""

    wxScintilla (wxWindow *parent, wxWindowID id=wxID_ANY,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize, long style = 0,
                 const wxString& name = wxSCINameStr);
    %name(PreScintilla) wxScintilla();

#else
    wxScintilla (wxWindow *parent, wxWindowID id=wxID_ANY,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize, long style = 0,
                 const wxString& name = wxSCINameStr);
    wxScintilla() { m_swx = NULL; }
    ~wxScintilla();

#endif

    bool Create (wxWindow *parent, wxWindowID id=wxID_ANY,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize, long style = 0,
                 const wxString& name = wxSCINameStr);


//----------------------------------------------------------------------
// BEGIN generated section.  The following code is automatically generated
//       by gen_iface.py.  Do not edit this file.  Edit wxscintilla.h.in instead
//       and regenerate


    // Add text to the document.
    void AddText (const wxString& text);
    void AddText (const int length, const wxString& text);

    // Add array of cells to document.
    void AddStyledText (const wxMemoryBuffer& data);

    // Insert string at a position.
    void InsertText (int pos, const wxString& text);

    // Delete all text in the document.
    void ClearAll();

    // Set all style bytes to 0, remove all folding information.
    void ClearDocumentStyle();

    // The number of characters in the document.
    int GetLength();

    // Returns the character byte at the position.
    int GetCharAt (int pos);

    // Returns the position of the caret.
    int GetCurrentPos();

    // Returns the position of the opposite end of the selection to the caret.
    int GetAnchor();

    // Returns the style byte at the position.
    int GetStyleAt (int pos);

    // Redoes the next action on the undo history.
    void Redo();

    // Choose between collecting actions into the undo
    // history and discarding them.
    void SetUndoCollection (bool collectUndo);

    // Select all the text in the document.
    void SelectAll();

    // Remember the current position in the undo history as the position
    // at which the document was saved.
    void SetSavePoint();

    // Retrieve a buffer of cells.
    wxMemoryBuffer GetStyledText (int startPos, int endPos);

    // Are there any redoable actions in the undo history?
    bool CanRedo();

    // Retrieve the line number at which a particular marker is located.
    int MarkerLineFromHandle (int handle);

    // Delete a marker.
    void MarkerDeleteHandle (int handle);

    // Is undo history being collected?
    bool GetUndoCollection();

    // Are white space characters currently visible?
    // Returns one of SCWS_* constants.
    int GetViewWhiteSpace();

    // Make white space characters invisible, always visible or visible outside indentation.
    void SetViewWhiteSpace (int viewWS);

    // Find the position from a point within the window.
    int PositionFromPoint (wxPoint pt);

    // Find the position from a point within the window but return
    // INVALID_POSITION if not close to text.
    int PositionFromPointClose (int x, int y);

    // Set caret to start of a line and ensure it is visible.
    void GotoLine (int line);

    // Set caret to a position and ensure it is visible.
    void GotoPos (int pos);

    // Set the selection anchor to a position. The anchor is the opposite
    // end of the selection from the caret.
    void SetAnchor (int posAnchor);

    // Retrieve the text of the line containing the caret.
    // Returns the index of the caret on the line.
#ifdef SWIG
    wxString GetCurLine (int* OUTPUT);
#else
    wxString GetCurLine (int* linePos=NULL);
#endif

    // Retrieve the position of the last correctly styled character.
    int GetEndStyled();

    // Convert all line endings in the document to one mode.
    void ConvertEOLs (int eolMode);

    // Retrieve the current end of line mode - one of CRLF, CR, or LF.
    int GetEOLMode();

    // Set the current end of line mode.
    void SetEOLMode (int eolMode);

    // Set the current styling position to pos and the styling mask to mask.
    // The styling mask can be used to protect some bits in each styling byte from modification.
    void StartStyling (int pos, int mask);

    // Change style from current styling position for length characters to a style
    // and move the current styling position to after this newly styled segment.
    void SetStyling (int length, int style);

    // Is drawing done first into a buffer or direct to the screen?
    bool GetBufferedDraw();

    // If drawing is buffered then each line of text is drawn into a bitmap buffer
    // before drawing it to the screen to avoid flicker.
    void SetBufferedDraw (bool buffered);

    // Change the visible size of a tab to be a multiple of the width of a space character.
    void SetTabWidth (int tabWidth);

    // Retrieve the visible size of a tab.
    int GetTabWidth();

    // Set the code page used to interpret the bytes of the document as characters.
    void SetCodePage (int codePage);

    // Set the symbol used for a particular marker number,
    void MarkerDefine (int markerNumber, int markerSymbol);

    // Set the foreground colour used for a particular marker number.
    void MarkerSetForeground (int markerNumber, const wxColour& fore);

    // Set the background colour used for a particular marker number.
    void MarkerSetBackground (int markerNumber, const wxColour& back);

    // Add a marker to a line, returning an ID which can be used to find or delete the marker.
    int MarkerAdd (int line, int markerNumber);

    // Delete a marker from a line.
    void MarkerDelete (int line, int markerNumber);

    // Delete a marker with a particular number from all lines.
    void MarkerDeleteAll (int markerNumber);

    // Get a bit mask of all the markers set on a line.
    int MarkerGet (int line);

    // Find the next line after lineStart that includes a marker in mask.
    int MarkerNext (int lineStart, int markerMask);

    // Find the previous line before lineStart that includes a marker in mask.
    int MarkerPrevious (int lineStart, int markerMask);

    // Define a marker from a bitmap
    void MarkerDefineBitmap (int markerNumber, const wxBitmap& bmp);

    // Set a margin to be either numeric or symbolic.
    void SetMarginType (int margin, int marginType);

    // Retrieve the type of a margin.
    int GetMarginType (int margin);

    // Set the width of a margin to a width expressed in pixels.
    void SetMarginWidth (int margin, int pixels);

    // Retrieve the width of a margin in pixels.
    int GetMarginWidth (int margin);

    // Set a mask that determines which markers are displayed in a margin.
    void SetMarginMask (int margin, int mask);

    // Retrieve the marker mask of a margin.
    int GetMarginMask (int margin);

    // Make a margin sensitive or insensitive to mouse clicks.
    void SetMarginSensitive (int margin, bool sensitive);

    // Retrieve the mouse click sensitivity of a margin.
    bool GetMarginSensitive (int margin);

    // Clear all the styles and make equivalent to the global default style.
    void StyleClearAll();

    // Set the foreground colour of a style.
    void StyleSetForeground (int style, const wxColour& fore);

    // Set the background colour of a style.
    void StyleSetBackground (int style, const wxColour& back);

    // Set a style to be bold or not.
    void StyleSetBold (int style, bool bold);

    // Set a style to be italic or not.
    void StyleSetItalic (int style, bool italic);

    // Set the size of characters of a style.
    void StyleSetSize (int style, int sizePoints);

    // Set the font of a style.
    void StyleSetFaceName (int style, const wxString& fontName);

    // Set a style to have its end of line filled or not.
    void StyleSetEOLFilled (int style, bool filled);

    // Reset the default style to its state at startup
    void StyleResetDefault();

    // Set a style to be underlined or not.
    void StyleSetUnderline (int style, bool underline);

    // Set a style to be mixed case, or to force upper or lower case.
    void StyleSetCase (int style, int caseMode);

    // Set a style to be a hotspot or not.
    void StyleSetHotSpot (int style, bool hotspot);

    // Set the foreground colour of the selection and whether to use this setting.
    void SetSelForeground (bool useSetting, const wxColour& fore);

    // Set the background colour of the selection and whether to use this setting.
    void SetSelBackground (bool useSetting, const wxColour& back);

    // Set the foreground colour of the caret.
    void SetCaretForeground (const wxColour& fore);

    // When key+modifier combination km is pressed perform msg.
    void CmdKeyAssign (int key, int modifiers, int cmd);

    // When key+modifier combination km is pressed do nothing.
    void CmdKeyClear (int key, int modifiers);

    // Drop all key mappings.
    void CmdKeyClearAll();

    // Set the styles for a segment of the document.
    void SetStyleBytes (int length, char* styleBytes);

    // Set a style to be visible or not.
    void StyleSetVisible (int style, bool visible);

    // Get the time in milliseconds that the caret is on and off.
    int GetCaretPeriod();

    // Get the time in milliseconds that the caret is on and off. 0 = steady on.
    void SetCaretPeriod (int milliseconds);

    // Set the set of characters making up words for when moving or selecting by word.
    // First sets deaults like SetCharsDefault.
    void SetWordChars (const wxString& characters);

    // Start a sequence of actions that is undone and redone as a unit.
    // May be nested.
    void BeginUndoAction();

    // End a sequence of actions that is undone and redone as a unit.
    void EndUndoAction();

    // Set an indicator to plain, squiggle or TT.
    void IndicatorSetStyle (int indic, int style);

    // Retrieve the style of an indicator.
    int IndicatorGetStyle (int indic);

    // Set the foreground colour of an indicator.
    void IndicatorSetForeground (int indic, const wxColour& fore);

    // Retrieve the foreground colour of an indicator.
    wxColour IndicatorGetForeground (int indic);

    // Set the foreground colour of all whitespace and whether to use this setting.
    void SetWhitespaceForeground (bool useSetting, const wxColour& fore);

    // Set the background colour of all whitespace and whether to use this setting.
    void SetWhitespaceBackground (bool useSetting, const wxColour& back);

    // Divide each styling byte into lexical class bits (default: 5) and indicator
    // bits (default: 3). If a lexer requires more than 32 lexical states, then this
    // is used to expand the possible states.
    void SetStyleBits (int bits);

    // Retrieve number of bits in style bytes used to hold the lexical state.
    int GetStyleBits();

    // Used to hold extra styling information for each line.
    void SetLineState (int line, int state);

    // Retrieve the extra styling information for a line.
    int GetLineState (int line);

    // Retrieve the last line number that has line state.
    int GetMaxLineState();

    // Is the background of the line containing the caret in a different colour?
    bool GetCaretLineVisible();

    // Display the background of the line containing the caret in a different colour.
    void SetCaretLineVisible (bool show);

    // Get the colour of the background of the line containing the caret.
    wxColour GetCaretLineBackground();

    // Set the colour of the background of the line containing the caret.
    void SetCaretLineBackground (const wxColour& back);

    // Set a style to be changeable or not (read only).
    // Experimental feature, currently buggy.
    void StyleSetChangeable (int style, bool changeable);

    // Display a auto-completion list.
    // The lenEntered parameter indicates how many characters before
    /