Preferences/PreferencesLexer.py

branch
sub_styles
changeset 6861
20899dc18e59
parent 6858
9d962e654978
child 6864
7837ab17f079
equal deleted inserted replaced
6860:50069cc0ee49 6861:20899dc18e59
335 if substyle >= 0: 335 if substyle >= 0:
336 self.__lex.setSubstyleFont(f, style, substyle) 336 self.__lex.setSubstyleFont(f, style, substyle)
337 else: 337 else:
338 self.__lex.setFont(f, style) 338 self.__lex.setFont(f, style)
339 339
340 def defaultWords(self, style, substyle=-1):
341 """
342 Public method to get the default list of words for a style.
343
344 @param style style number
345 @type int
346 @param substyle sub-style number
347 @type int
348 @return whitespace separated default list of words
349 @rtype str
350 """
351 if substyle >= 0:
352 words = self.__lex.substyleDefaultWords(style, substyle)
353 else:
354 words = ""
355
356 return words
357
358 def words(self, style, substyle=-1):
359 """
360 Public method to get the list of words for a style.
361
362 @param style style number
363 @type int
364 @param substyle sub-style number
365 @type int
366 @return whitespace separated list of words
367 @rtype str
368 """
369 if substyle >= 0:
370 words = self.__lex.substyleWords(style, substyle)
371 else:
372 words = ""
373
374 return words
375
376 def setWords(self, words, style, substyle=-1):
377 """
378 Public method to set the list of words for a style.
379
380 @param words whitespace separated list of words
381 @type str
382 @param style style number
383 @type int
384 @param substyle sub-style number
385 @type int
386 """
387 if substyle >= 0:
388 # only supported for sub-styles
389 self.__lex.setSubstyleWords(words, style, substyle)
390
391 def defaultDescription(self, style, substyle=-1):
392 """
393 Public method to get the default descriptive string for a style.
394
395 @param style style number
396 @type int
397 @param substyle sub-style number
398 @type int
399 @return default description of the style
400 @rtype str
401 """
402 if substyle >= 0:
403 desc = self.__lex.substyleDefaultDescription(style, substyle)
404 else:
405 # for base styles return the hard coded description
406 desc = self.__lex.description(style)
407
408 return desc
409
340 def description(self, style, substyle=-1): 410 def description(self, style, substyle=-1):
341 """ 411 """
342 Public method to get a descriptive string for a style. 412 Public method to get a descriptive string for a style.
343 413
344 @param style style number 414 @param style style number
346 @param substyle sub-style number 416 @param substyle sub-style number
347 @type int 417 @type int
348 @return description of the style 418 @return description of the style
349 @rtype str 419 @rtype str
350 """ 420 """
351 return self.__lex.description(style) 421 if substyle >= 0:
422 desc = self.__lex.substyleDescription(style, substyle)
423 else:
424 desc = self.__lex.description(style)
425
426 return desc
427
428 def setDescription(self, description, style, substyle=-1):
429 """
430 Public method to set a descriptive string for a style.
431
432 @param description description for the style
433 @type str
434 @param style style number
435 @type int
436 @param substyle sub-style number
437 @type int
438 """
439 if substyle >= 0:
440 # only supported for sub-styles
441 self.__lex.setSubstyleDescription(description, style, substyle)
352 442
353 def language(self): 443 def language(self):
354 """ 444 """
355 Public method to get the lexers programming language. 445 Public method to get the lexers programming language.
356 446
357 @return lexer programming language 447 @return lexer programming language
358 @rtype str 448 @rtype str
359 """ 449 """
360 return self.__lex.language() 450 return self.__lex.language()
451
452 def hasStyle(self, style, substyle):
453 """
454 Public method to test for a given style definition.
455
456 @param style style number
457 @type int
458 @param substyle sub-style number
459 @type int
460 @return flag indicating the existence of a style definition
461 @rtype bool
462 """
463 if substyle >= 0:
464 ok = self.__lex.hasSubstyle(style, substyle)
465 else:
466 ok = True
467
468 return ok
469
470 def addSubstyle(self, style):
471 """
472 Public method to add an empty sub-style to a given style.
473
474 @param style style number
475 @type int
476 @return allocated sub-style number or -1 to indicate an error
477 @rtype int
478 """
479 return self.__lex.addSubstyle(style)

eric ide

mercurial