/////////////////////////////////////////////////////////////////////////////
// Name: stc/stc.h
-// Purpose: documentation for wxStyledTextEvent class
+// Purpose: interface of wxStyledTextEvent
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@class wxStyledTextEvent
@headerfile stc.h wx/stc/stc.h
-
+
The type of events sent from wxStyledTextCtrl.
-
+
TODO
-
+
@library{wxbase}
@category{FIXME}
*/
*/
wxStyledTextEvent(wxEventType commandType = 0, int id = 0);
- wxStyledTextEvent(const wxStyledTextEvent& event);
+ wxStyledTextEvent(const wxStyledTextEvent& event);
//@}
/**
*/
- wxEvent* Clone();
+ wxEvent* Clone() const;
/**
*/
- bool GetAlt();
+ bool GetAlt() const;
/**
*/
- bool GetControl();
+ bool GetControl() const;
/**
/**
*/
- int GetFoldLevelNow();
+ int GetFoldLevelNow() const;
/**
*/
- int GetFoldLevelPrev();
+ int GetFoldLevelPrev() const;
/**
*/
- int GetKey();
+ int GetKey() const;
/**
*/
- int GetLParam();
+ int GetLParam() const;
/**
*/
- int GetLength();
+ int GetLength() const;
/**
*/
- int GetLine();
+ int GetLine() const;
/**
*/
- int GetLinesAdded();
+ int GetLinesAdded() const;
/**
*/
- int GetListType();
+ int GetListType() const;
/**
*/
- int GetMargin();
+ int GetMargin() const;
/**
*/
- int GetMessage();
+ int GetMessage() const;
/**
*/
- int GetModificationType();
+ int GetModificationType() const;
/**
*/
- int GetModifiers();
+ int GetModifiers() const;
/**
*/
- int GetPosition();
+ int GetPosition() const;
/**
*/
- bool GetShift();
+ bool GetShift() const;
/**
*/
- wxString GetText();
+ wxString GetText() const;
/**
*/
- int GetWParam();
+ int GetWParam() const;
/**
*/
-#define int GetX() /* implementation is private */
+ int GetX() const;
/**
*/
-#define int GetY() /* implementation is private */
+ int GetY() const;
/**
/**
*/
-#define void SetX(int val) /* implementation is private */
+ void SetX(int val);
/**
*/
-#define void SetY(int val) /* implementation is private */
+ void SetY(int val);
};
+
/**
@class wxStyledTextCtrl
@headerfile stc.h wx/stc/stc.h
-
+
A wxWidgets implementation of the Scintilla source code editing component.
-
+
As well as features found in standard text editing components, Scintilla
- includes
+ includes
features especially useful when editing and debugging source code. These
- include
+ include
support for syntax styling, error indicators, code completion and call tips.
- The
- selection margin can contain markers like those used in debuggers to indicate
- breakpoints and the current line. Styling choices are more open than with many
- editors, allowing the use of proportional fonts, bold and italics, multiple
+ The
+ selection margin can contain markers like those used in debuggers to indicate
+ breakpoints and the current line. Styling choices are more open than with many
+ editors, allowing the use of proportional fonts, bold and italics, multiple
foreground and background colours and multiple fonts.
-
+
wxStyledTextCtrl is a 1 to 1 mapping of "raw" scintilla interface, whose
documentation
can be found in the Scintilla website.
-
+
@library{wxbase}
@category{stc}
-
- @seealso
- wxStyledTextEvent
+
+ @see wxStyledTextEvent
*/
class wxStyledTextCtrl : public wxControl
{
/**
Ctor.
*/
- wxStyledTextCtrl::wxStyledTextCtrl(wxWindow * parent,
+ wxStyledTextCtrl::wxStyledTextCtrl(wxWindow* parent,
wxWindowID id = wxID_ANY,
const wxPoint pos = wxDefaultPosition,
const wxSize size = wxDefaultSize,
/**
Cut the selection to the clipboard.
*/
-#define void Cut() /* implementation is private */
+ void Cut();
/**
Delete back from the current position to the start of the line.
/**
END of generated section
-
Others...
Returns the line number of the line with the caret.
*/
int ReplaceTarget(const wxString& text);
/**
- Replace the target text with the argument text after
+ Replace the target text with the argument text after
d processing.
Text is counted so it can contain NULs.
- Looks for
+ Looks for
d where d is between 1 and 9 and replaces these with the strings
- matched in the last search operation which were surrounded by
- ( and
+ matched in the last search operation which were surrounded by
+ ( and
).
Returns the length of the replacement text including any change
- caused by processing the
+ caused by processing the
d patterns.
*/
int ReplaceTargetRE(const wxString& text);
character.
If more than one line selected, indent the lines.
*/
-#define void Tab() /* implementation is private */
+ void Tab();
/**
Make the target range start and end be the same as the selection range start
*/
void ZoomOut();
};
+