wxPython/demo/StyledTextCtrl_1.py

   1 #
   2 # 11/21/2003 - Jeff Grimmett (grimmtooth@softhome.net)
   3 #
   4 # o wx.TheClipboard.Flush() generates a warning on program exit.
   5 #
   6
   7 import  wx
   8 import  wx.stc  as  stc
   9
  10 import  images
  11
  12 #----------------------------------------------------------------------
  13
  14 debug = 1
  15
  16
  17 demoText = """\
  18 This editor is provided by a class named wx.StyledTextCtrl.  As
  19 the name suggests, you can define styles that can be applied to
  20 sections of text.  This will typically be used for things like
  21 syntax highlighting code editors, but I'm sure that there are other
  22 applications as well.  A style is a combination of font, point size,
  23 foreground and background colours.  The editor can handle
  24 proportional fonts just as easily as monospaced fonts, and various
  25 styles can use different sized fonts.
  26
  27 There are a few canned language lexers and colourizers included,
  28 (see the next demo) or you can handle the colourization yourself.
  29 If you do you can simply register an event handler and the editor
  30 will let you know when the visible portion of the text needs
  31 styling.
  32
  33 wx.StyledTextEditor also supports setting markers in the margin...
  34
  35
  36
  37
  38 ...and indicators within the text.  You can use these for whatever
  39 you want in your application.  Cut, Copy, Paste, Drag and Drop of
  40 text works, as well as virtually unlimited Undo and Redo
  41 capabilities, (right click to try it out.)
  42 """
  43
  44 if wx.Platform == '__WXMSW__':
  45     face1 = 'Arial'
  46     face2 = 'Times New Roman'
  47     face3 = 'Courier New'
  48     pb = 10
  49 else:
  50     face1 = 'Helvetica'
  51     face2 = 'Times'
  52     face3 = 'Courier'
  53     pb = 10
  54
  55
  56 #----------------------------------------------------------------------
  57 # This shows how to catch the Modified event from the wx.StyledTextCtrl
  58
  59 class MySTC(stc.StyledTextCtrl):
  60     def __init__(self, parent, ID, log):
  61         stc.StyledTextCtrl.__init__(self, parent, ID)
  62         self.log = log
  63
  64         self.Bind(stc.EVT_STC_DO_DROP, self.OnDoDrop)
  65         self.Bind(stc.EVT_STC_DRAG_OVER, self.OnDragOver)
  66         self.Bind(stc.EVT_STC_START_DRAG, self.OnStartDrag)
  67         self.Bind(stc.EVT_STC_MODIFIED, self.OnModified)
  68
  69         self.Bind(wx.EVT_WINDOW_DESTROY, self.OnDestroy)
  70
  71     def OnDestroy(self, evt):
  72         # This is how the clipboard contents can be preserved after
  73         # the app has exited.
  74         wx.TheClipboard.Flush()
  75         evt.Skip()
  76
  77
  78     def OnStartDrag(self, evt):
  79         self.log.write("OnStartDrag: %d, %s\n"
  80                        % (evt.GetDragAllowMove(), evt.GetDragText()))
  81
  82         if debug and evt.GetPosition() < 250:
  83             evt.SetDragAllowMove(False)     # you can prevent moving of text (only copy)
  84             evt.SetDragText("DRAGGED TEXT") # you can change what is dragged
  85             #evt.SetDragText("")             # or prevent the drag with empty text
  86
  87
  88     def OnDragOver(self, evt):
  89         self.log.write(
  90             "OnDragOver: x,y=(%d, %d)  pos: %d  DragResult: %d\n"
  91             % (evt.GetX(), evt.GetY(), evt.GetPosition(), evt.GetDragResult())
  92             )
  93
  94         if debug and evt.GetPosition() < 250:
  95             evt.SetDragResult(wx.DragNone)   # prevent dropping at the beginning of the buffer
  96
  97
  98     def OnDoDrop(self, evt):
  99         self.log.write("OnDoDrop: x,y=(%d, %d)  pos: %d  DragResult: %d\n"
 100                        "\ttext: %s\n"
 101                        % (evt.GetX(), evt.GetY(), evt.GetPosition(), evt.GetDragResult(),
 102                           evt.GetDragText()))
 103
 104         if debug and evt.GetPosition() < 500:
 105             evt.SetDragText("DROPPED TEXT")  # Can change text if needed
 106             #evt.SetDragResult(wx.DragNone)  # Can also change the drag operation, but it
 107                                              # is probably better to do it in OnDragOver so
 108                                              # there is visual feedback
 109
 110             #evt.SetPosition(25)             # Can also change position, but I'm not sure why
 111                                              # you would want to...
 112
 113
 114
 115
 116     def OnModified(self, evt):
 117         self.log.write("""OnModified
 118         Mod type:     %s
 119         At position:  %d
 120         Lines added:  %d
 121         Text Length:  %d
 122         Text:         %s\n""" % ( self.transModType(evt.GetModificationType()),
 123                                   evt.GetPosition(),
 124                                   evt.GetLinesAdded(),
 125                                   evt.GetLength(),
 126                                   repr(evt.GetText()) ))
 127
 128
 129     def transModType(self, modType):
 130         st = ""
 131         table = [(stc.STC_MOD_INSERTTEXT, "InsertText"),
 132                  (stc.STC_MOD_DELETETEXT, "DeleteText"),
 133                  (stc.STC_MOD_CHANGESTYLE, "ChangeStyle"),
 134                  (stc.STC_MOD_CHANGEFOLD, "ChangeFold"),
 135                  (stc.STC_PERFORMED_USER, "UserFlag"),
 136                  (stc.STC_PERFORMED_UNDO, "Undo"),
 137                  (stc.STC_PERFORMED_REDO, "Redo"),
 138                  (stc.STC_LASTSTEPINUNDOREDO, "Last-Undo/Redo"),
 139                  (stc.STC_MOD_CHANGEMARKER, "ChangeMarker"),
 140                  (stc.STC_MOD_BEFOREINSERT, "B4-Insert"),
 141                  (stc.STC_MOD_BEFOREDELETE, "B4-Delete")
 142                  ]
 143
 144         for flag,text in table:
 145             if flag & modType:
 146                 st = st + text + " "
 147
 148         if not st:
 149             st = 'UNKNOWN'
 150
 151         return st
 152
 153
 154
 155
 156 #----------------------------------------------------------------------
 157
 158 _USE_PANEL = 1
 159
 160 def runTest(frame, nb, log):
 161     if not _USE_PANEL:
 162         ed = p = MySTC(nb, -1, log)
 163
 164     else:
 165         p = wx.Panel(nb, -1, style=wx.NO_FULL_REPAINT_ON_RESIZE)
 166         ed = MySTC(p, -1, log)
 167         s = wx.BoxSizer(wx.HORIZONTAL)
 168         s.Add(ed, 1, wx.EXPAND)
 169         p.SetSizer(s)
 170         p.SetAutoLayout(True)
 171
 172
 173     #ed.SetBufferedDraw(False)
 174     #ed.StyleClearAll()
 175     #ed.SetScrollWidth(800)
 176     #ed.SetWrapMode(True)
 177     #ed.SetUseAntiAliasing(False)
 178     #ed.SetViewEOL(True)
 179
 180     ed.SetText(demoText)
 181
 182     if wx.USE_UNICODE:
 183         import codecs
 184         decode = codecs.lookup("utf-8")[1]
 185
 186         ed.GotoPos(ed.GetLength())
 187         ed.AddText("\n\nwx.StyledTextCtrl can also do Unicode:\n")
 188         uniline = ed.GetCurrentLine()
 189         unitext, l = decode('\xd0\x9f\xd0\xb8\xd1\x82\xd0\xbe\xd0\xbd - '
 190                             '\xd0\xbb\xd1\x83\xd1\x87\xd1\x88\xd0\xb8\xd0\xb9 '
 191                             '\xd1\x8f\xd0\xb7\xd1\x8b\xd0\xba \xd0\xbf\xd1\x80\xd0\xbe\xd0\xb3\xd1\x80\xd0\xb0\xd0\xbc\xd0\xbc\xd0\xb8\xd1\x80\xd0\xbe\xd0\xb2\xd0\xb0\xd0\xbd\xd0\xb8\xd1\x8f!\n\n')
 192         ed.AddText('\tRussian: ')
 193         ed.AddText(unitext)
 194         ed.GotoPos(0)
 195     #else:
 196     #    #ed.StyleSetFontEncoding(stc.STC_STYLE_DEFAULT, wx.FONTENCODING_KOI8)
 197     #    #text = u'\u041f\u0438\u0442\u043e\u043d - \u043b\u0443\u0447\u0448\u0438\u0439 \u044f\u0437\u044b\u043a \n\u043f\u0440\u043e\u0433\u0440\u0430\u043c\u043c\u0438\u0440\u043e\u0432\u0430\u043d\u0438\u044f!'
 198     #    #text = text.encode('koi8-r')
 199     #    #ed.StyleSetFontEncoding(stc.STC_STYLE_DEFAULT, wx.FONTENCODING_BIG5)
 200     #    #text = u'Python \u662f\u6700\u597d\u7684\u7de8\u7a0b\u8a9e\u8a00\uff01'
 201     #    #text = text.encode('big5')
 202     #    ed.GotoPos(ed.GetLength())
 203     #    ed.AddText('\n\n' + text)
 204
 205     ed.EmptyUndoBuffer()
 206
 207     # make some styles
 208     ed.StyleSetSpec(stc.STC_STYLE_DEFAULT, "size:%d,face:%s" % (pb, face3))
 209     ed.StyleClearAll()
 210     ed.StyleSetSpec(1, "size:%d,bold,face:%s,fore:#0000FF" % (pb+2, face1))
 211     ed.StyleSetSpec(2, "face:%s,italic,fore:#FF0000,size:%d" % (face2, pb))
 212     ed.StyleSetSpec(3, "face:%s,bold,size:%d" % (face2, pb+2))
 213     ed.StyleSetSpec(4, "face:%s,size:%d" % (face1, pb-1))
 214
 215     # Now set some text to those styles...  Normally this would be
 216     # done in an event handler that happens when text needs displayed.
 217     ed.StartStyling(98, 0xff)
 218     ed.SetStyling(6, 1)  # set style for 6 characters using style 1
 219
 220     ed.StartStyling(190, 0xff)
 221     ed.SetStyling(20, 2)
 222
 223     ed.StartStyling(310, 0xff)
 224     ed.SetStyling(4, 3)
 225     ed.SetStyling(2, 0)
 226     ed.SetStyling(10, 4)
 227
 228
 229     # line numbers in the margin
 230     ed.SetMarginType(0, stc.STC_MARGIN_NUMBER)
 231     ed.SetMarginWidth(0, 22)
 232     ed.StyleSetSpec(stc.STC_STYLE_LINENUMBER, "size:%d,face:%s" % (pb, face1))
 233
 234     # setup some markers
 235     ed.SetMarginType(1, stc.STC_MARGIN_SYMBOL)
 236     ed.MarkerDefine(0, stc.STC_MARK_ROUNDRECT, "#CCFF00", "RED")
 237     #ed.MarkerDefine(1, stc.STC_MARK_CIRCLE, "FOREST GREEN", "SIENNA")
 238     ed.MarkerDefineBitmap(1, images.getFolder1Bitmap())
 239     ed.MarkerDefine(2, stc.STC_MARK_SHORTARROW, "blue", "blue")
 240     ed.MarkerDefine(3, stc.STC_MARK_ARROW, "#00FF00", "#00FF00")
 241
 242     # put some markers on some lines
 243     ed.MarkerAdd(17, 0)
 244     ed.MarkerAdd(18, 1)
 245     ed.MarkerAdd(19, 2)
 246     ed.MarkerAdd(20, 3)
 247     ed.MarkerAdd(20, 0)
 248
 249
 250     # and finally, an indicator or two
 251     ed.IndicatorSetStyle(0, stc.STC_INDIC_SQUIGGLE)
 252     ed.IndicatorSetForeground(0, wx.RED)
 253     ed.IndicatorSetStyle(1, stc.STC_INDIC_DIAGONAL)
 254     ed.IndicatorSetForeground(1, wx.BLUE)
 255     ed.IndicatorSetStyle(2, stc.STC_INDIC_STRIKE)
 256     ed.IndicatorSetForeground(2, wx.RED)
 257
 258     ed.StartStyling(836, stc.STC_INDICS_MASK)
 259     ed.SetStyling(10, stc.STC_INDIC0_MASK)
 260     ed.SetStyling(10, stc.STC_INDIC1_MASK)
 261     ed.SetStyling(10, stc.STC_INDIC2_MASK | stc.STC_INDIC1_MASK)
 262
 263
 264     # some test stuff...
 265     if debug:
 266         print "GetTextLength(): ", ed.GetTextLength(), len(ed.GetText())
 267         print "GetText(): ", repr(ed.GetText())
 268         print
 269         print "GetStyledText(98, 104): ", repr(ed.GetStyledText(98, 104)), len(ed.GetStyledText(98, 104))
 270         print
 271         print "GetCurLine(): ", repr(ed.GetCurLine())
 272         ed.GotoPos(5)
 273         print "GetCurLine(): ", repr(ed.GetCurLine())
 274         print
 275         print "GetLine(1): ", repr(ed.GetLine(1))
 276         print
 277         ed.SetSelection(25, 35)
 278         print "GetSelectedText(): ", repr(ed.GetSelectedText())
 279         print "GetTextRange(25, 35): ", repr(ed.GetTextRange(25, 35))
 280         print "FindText(0, max, 'indicators'): ",
 281         print ed.FindText(0, ed.GetTextLength(), "indicators")
 282         if wx.USE_UNICODE:
 283             end = ed.GetLength()
 284             start = ed.PositionFromLine(uniline)
 285             print "GetTextRange(%d, %d): " % (start, end),
 286             print repr(ed.GetTextRange(start, end))
 287
 288
 289     wx.CallAfter(ed.GotoPos, 0)
 290     return p
 291
 292
 293
 294 #----------------------------------------------------------------------
 295
 296
 297 overview = """\
 298 <html><body>
 299 Once again, no docs yet.  <b>Sorry.</b>  But <a href="data/stc.h.html">this</a>
 300 and <a href="http://www.scintilla.org/ScintillaDoc.html">this</a> should
 301 be helpful.
 302 </body><html>
 303 """
 304
 305
 306 if __name__ == '__main__':
 307     import sys,os
 308     import run
 309     run.main(['', os.path.basename(sys.argv[0])] + sys.argv[1:])
 310