Package bpy :: Package ops :: Module font
[hide private]
[frames] | no frames]

Module font

Functions [hide private]
 
buffer_paste()
Paste text from OS buffer.
 
case_set(case='LOWER')
Set font case.
 
case_toggle()
Toggle font case.
 
change_character(delta=1)
Change font character code.
 
change_spacing(delta=1)
Change font spacing.
 
delete(type='ALL')
Delete text by cursor position.
 
file_paste(path='', filename='', directory='', filter_blender=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=True, filter_folder=True, filemode=9)
Paste contents from file.
 
insert_lorem()
Insert placeholder text.
 
line_break(ctrl=False)
Insert line break at cursor position.
 
move(type='LINE_BEGIN')
Move cursor to position type.
 
move_select(type='LINE_BEGIN')
Make selection from current cursor position to new cursor position type.
 
style_set(style='BOLD', clear=False)
Set font style.
 
style_toggle(style='BOLD')
Toggle font style.
 
text_copy()
Copy selected text to clipboard.
 
text_cut()
Cut selected text to clipboard.
 
text_insert(text='')
Insert text at cursor position.
 
text_paste()
Paste text from clipboard.
Function Details [hide private]

case_set(case='LOWER')

 

Set font case.

Parameters:
  • case (enum) - Lower or upper case. in (LOWER, UPPER)

change_character(delta=1)

 

Change font character code.

Parameters:
  • delta (int) - Number to increase or decrease character code with. in (-255, 255)

change_spacing(delta=1)

 

Change font spacing.

Parameters:
  • delta (int) - Amount to decrease or increasing character spacing with. in (-20, 20)

delete(type='ALL')

 

Delete text by cursor position.

Parameters:
  • type (enum) - Which part of the text to delete. in (ALL, NEXT_CHARACTER, PREVIOUS_CHARACTER, SELECTION, NEXT_OR_SELECTION, PREVIOUS_OR_SELECTION)

file_paste(path='', filename='', directory='', filter_blender=False, filter_image=False, filter_movie=False, filter_python=False, filter_font=False, filter_sound=False, filter_text=True, filter_folder=True, filemode=9)

 

Paste contents from file.

Parameters:
  • filemode (int) - The setting for the file browser mode to load a .blend file, a library or a special file. in (1, 9)
  • filter_text (boolean)
  • filter_sound (boolean)
  • filter_image (boolean)
  • filter_movie (boolean)
  • filter_blender (boolean)
  • filename (string)
  • filter_font (boolean)
  • filter_python (boolean)
  • directory (string)
  • path (string)
  • filter_folder (boolean)

line_break(ctrl=False)

 

Insert line break at cursor position.

Parameters:
  • ctrl (boolean)

move(type='LINE_BEGIN')

 

Move cursor to position type.

Parameters:
  • type (enum) - Where to move cursor to. in (LINE_BEGIN, LINE_END, PREVIOUS_CHARACTER, NEXT_CHARACTER, PREVIOUS_WORD, NEXT_WORD, PREVIOUS_LINE, NEXT_LINE, PREVIOUS_PAGE, NEXT_PAGE)

move_select(type='LINE_BEGIN')

 

Make selection from current cursor position to new cursor position type.

Parameters:
  • type (enum) - Where to move cursor to, to make a selection. in (LINE_BEGIN, LINE_END, PREVIOUS_CHARACTER, NEXT_CHARACTER, PREVIOUS_WORD, NEXT_WORD, PREVIOUS_LINE, NEXT_LINE, PREVIOUS_PAGE, NEXT_PAGE)

style_set(style='BOLD', clear=False)

 

Set font style.

Parameters:
  • style (enum) - Style to set selection to. in (BOLD, ITALIC, UNDERLINE)
  • clear (boolean)

style_toggle(style='BOLD')

 

Toggle font style.

Parameters:
  • style (enum) - Style to set selection to. in (BOLD, ITALIC, UNDERLINE)

text_insert(text='')

 

Insert text at cursor position.

Parameters:
  • text (string)