W3 Tools :: PHP-GTK Manual

Scintilla Classes
Prev	GtkScintilla	Next

GtkScintilla

GtkScintilla is an advanced text edition component with code completion, sintax highlight and others.

Object Hierarchy

GtkObject
`-- GtkWidget
       `-- GtkContainer
              `-- GtkBin
                     `-- GtkFrame
                            `-- GtkScintilla

Direct subclasses

None.

Description

GtkScintilla is an advanced widget for code edition. It's a component with lots of resources that make it a great choice to write code editors. GtkScintilla provides advanced features like code completion, sintax highlight, caret lines, line numbers, besides lots of text controls, giving strong powers to the programmer. GtkScintilla inherits from GtkFrame, so you can embbed GtkScintilla object inside another containers like GtkWindow, GtkVBox, GtkHBox, GtkFrame and others.

Constructor

GtkScintilla (void);
-- Creates the GtkScintilla text area.

Methods

find_text()
Finds a portion of text in GtkScintilla.
add_text()
Add the string at the end of text area.
insert_text()
Inserts text in the text area of GtkScintilla.
clear_all()
Clear all text area.
clear_document_style()

get_length()
Gets the length of the text inside the text area.
get_current_pos()
Gets the current position of cursor. It means the character position inside the text.
get_char_at()
Return the character that is located at the specific position.
get_anchor()

get_style_at()

redo()
Redo is like "redo" action of every text editor. Redo does again some task undone by "Undo" operation.
set_undo_collection()

select_all()
Select all text inside the text area.
set_save_point()

marker_line_from_handle()

marker_delete_handle()

get_undo_collection()

get_view_ws()

set_view_ws()

position_from_point()

goto_line()
This method set the cursor position to the specific line.
goto_pos()
This method set the cursor position to the specific character position.
set_anchor()

get_cur_line()
Returns an array containing the current line string and the current column.
get_end_styled()

convert_eols()

get_eol_mode()
Return the current End of Line Mode. See set_eol_mode() .
set_eol_mode()
Define the End of Line Mode.
start_styling()

set_styling()

get_buffered_draw()

set_buffered_draw()

set_tab_width()
Set the Tab Width.
get_tab_width()
Gets the Tab Width.
set_code_page()

set_use_palette()

marker_define()
Define a specific symbol for a marker number.
marker_set_fore()
Set the Fore color of a marker, for markers table, see marker_define()
marker_set_back()
Set the Background color of a marker, for markers table, see marker_define()
marker_add()
Add a Marker symbol in front of the line, for markers table, see marker_define()
marker_delete()
Deletes a Marker symbol from the line, for markers table, see marker_define()
marker_delete_all()
Removes all line markers of a specific type, for markers table, see marker_define()
marker_get()

marker_next()

marker_previous()

set_margin_type_n()

get_margin_type_n()

set_margin_width_n()

get_margin_width_n()

set_margin_mask_n()

get_margin_mask_n()

set_margin_sensitive_n()

get_margin_sensitive_n()

style_clear_all()

style_set_fore()
Set the fore color of some style.
style_set_back()
Set the background color of some style.
style_set_bold()
Define some style to be formated as bold.
style_set_italic()
Define some style to be formated as italic.
style_set_size()
Define the size of some style
style_set_font()
Set the font of some style.
style_set_eol_filled()

style_reset_default()

style_set_underline()
Define some style to be formated as underlined.
style_set_case()
Turn OFF/ON the Case Sensitive of some Style.
style_set_character_set()

set_sel_fore()
Set the fore color of the selection.
set_sel_back()
Set the back color of the selection.
set_caret_fore()

get_caret_fore()

clear_all_cmd_keys()

set_styling_ex()

style_set_visible()
Define if some style will be visible or not.
get_caret_period()

set_caret_period()

set_word_chars()

begin_undo_action()
Define when start to store the actions of the user for "Undo Action".
end_undo_action()
Define when finish to store the actions of the user for "Undo Action".
indic_set_style()

indic_get_style()

indic_set_fore()

indic_get_fore()

set_style_bits()

get_style_bits()

set_line_state()

get_line_state()

get_max_line_state()

set_caret_line_visible()
Define if the selected line must have the background in another color.
get_caret_line_visible()
Return if caret lines are visible or not.
get_caret_line_back()
Get the background color of Caret Lines.
set_caret_line_back()
Changes the background color of the Caret Lines.
autoc_show()
Show the auto-complation list.
autoc_cancel()

autoc_active()

autoc_pos_start()

autoc_complete()

autoc_stops()

autoc_set_separator()

autoc_get_separator()

autoc_select()

autoc_set_cancel_at_start()

autoc_get_cancel_at_start()

autoc_set_fill_ups()

autoc_set_choose_single()

autoc_get_choose_single()

autoc_set_ignore_case()

autoc_get_ignore_case()

user_list_show()

autoc_set_auto_hide()

autoc_get_auto_hide()

set_indent()
Set indentation size.
get_indent()
Get Indentation Size.
set_use_tabs()
Set if the [TAB] key must use tabs or spaces.
get_use_tabs()
Get if the [TAB] key is using tabs or spaces.
set_line_indentation()
Set the line indentation of some line.
get_line_indentation()
Get the Line indentation of some line.
get_line_indent_position()

get_column()
Returns the column number of the character position.
set_h_scroll_bar()

get_h_scroll_bar()

set_indentation_guides()
Set wheather the indentation guides are visible or not.
get_indentation_guides()
Get wheather the indentation guides are visible or not.
set_highlight_guide()

get_highlight_guide()

get_line_end_position()

get_code_page()

get_use_palette()

get_read_only()

set_current_pos()

set_selection_start()
Set the start of the selection (character position).
get_selection_start()
Get the begin of the selection (character position).
set_selection_end()
Set the end of the selection (character position).
get_selection_end()
Get the end of the selection (character position).
set_print_magnification()

get_print_magnification()

set_print_colour_mode()

get_print_colour_mode()

get_first_visible_line()

get_line()
Get the content of some line.
get_line_count()
Get the quantity of lines of the text area.
set_margin_left()

get_margin_left()

set_margin_right()

get_margin_right()

get_modify()

set_sel()

get_sel_text()
Get the selected text.
hide_selection()

point_x_from_position()

point_y_from_position()

line_from_position()
Get the line number from character position.
position_from_line()
Get the character position from the line number.
line_scroll()

scroll_caret()

replace_sel()

set_read_only()
Define if the text area may be edited or not.
null()

can_redo()
Can Redo returns wheather "Redo" Operation may be done or not.
can_paste()
Can Paste returns wheather "Paste" Operation may be done or not.
can_undo()
Can Undo returns wheather "Undo" Operation may be done or not.
empty_undo_buffer()
Empty the action list for "Undo" Action.
undo()
Undo makes the last action undone.
cut()
Cut the selected text and transfer it to the memory.
copy()
Copy the selected text and transfer it to the memory.
paste()
Paste the selected text from the memory to the text area.
clear()

set_text()
Set all the content of Scintilla text area edition with the specified string.
get_text()
Return all the content of Scintilla text area edition as a string.
get_text_length()
Return the length of the text inside scintilla object.
get_direct_function()

get_direct_pointer()

set_overtype()

get_overtype()

set_caret_width()

get_caret_width()

set_target_start()

get_target_start()

set_target_end()

get_target_end()

replace_target()

replace_target_re()

search_in_target()

set_search_flags()

get_search_flags()

call_tip_show()
Show the sintax hint about one function
call_tip_cancel()

call_tip_active()

call_tip_pos_start()

call_tip_set_hlt()

call_tip_set_back()

visible_from_doc_line()

doc_line_from_visible()

set_fold_level()
Define the fold level for some line. Fold level means the level of braces {} in the code.
get_fold_level()
Returns the fold level for some line. See set_fold_level()
get_last_child()

get_fold_parent()

show_lines()
Show the specified lines.
hide_lines()
Hide the specified lines.
get_line_visible()

set_fold_expanded()

get_fold_expanded()

toggle_fold()

ensure_visible()

set_fold_flags()

set_tab_indents()

get_tab_indents()

set_backspace_unindents()

get_backspace_unindents()

line_down()
Places the cursor one line down.
line_down_extend()
Selects one line down.
line_up()
Places the cursor one line up.
line_up_extend()
Selects one line up.
char_left()
Places the cursor one character to the left.
char_left_extend()
Selects the character at the left side.
char_right()
Places the cursor one character to the right.
char_right_extend()
Selects the character at the right side.
word_left()
Places the cursor one word to the left.
word_left_extend()
Selects the word at the left side.
word_right()
Places the cursor one word to the right.
word_right_extend()
Selects the word at the right side.
home()
Places the cursor at the begin of the line.
home_extend()
Selects the text untill the home of the line.
line_end()
Places the cursor at the end of the line.
line_end_extend()
Selects the text untill the end of the line.
document_start()

document_start_extend()

document_end()

document_end_extend()

page_up()
Goes one page up.
page_up_extend()
Selects the text of one page up.
page_down()
Goes one page down.
page_down_extend()
Selects the text of one page down.
edit_toggle_overtype()

cancel()

delete_back()

tab()

back_tab()

new_line()

form_feed()

v_c_home()

v_c_home_extend()

zoom_in()

zoom_out()

del_word_left()
Delete word of the left side of the cursor.
del_word_right()
Delete word of the right side of the cursor.
line_cut()
Cuts the current line's content to the memory.
line_delete()
Deletes the current line.
line_transpose()

lower_case()

upper_case()

line_scroll_down()

line_scroll_up()

move_caret_inside_view()

line_length()
Return the length of some line.
brace_match()
Get the character position of the complement of "{", "[", "("
brace_highlight()
Set positions inside the text to be showed in brace mode.
brace_bad_light()

get_view_eol()
Get wheather the end of line marks are visible or not.
set_view_eol()
Define wheather the end of line marks are visible or not.
get_doc_pointer()

set_doc_pointer()

set_mod_event_mask()

get_edge_column()
Returns the column number that is used as the edge of text area.
set_edge_column()
Changes the column number that is used as the edge of the text area.
get_edge_mode()
Returns the edge mode. See set_edge_mode()
set_edge_mode()
Changes the edge mode.
get_edge_colour()
Gets the background color of text out of the edge.
set_edge_colour()
Changes the background color of text out of the edge.
search_anchor()

search_next()

search_prev()

set_caret_policy()

lines_on_screen()

use_pop_up()

selection_is_rectangle()

set_zoom()

get_zoom()

create_document()

add_ref_document()

release_document()

get_mod_event_mask()

set_focus()

get_focus()

set_status()

get_status()

set_mouse_down_captures()

get_mouse_down_captures()

set_cursor()

get_cursor()

word_part_left()

word_part_left_extend()

word_part_right()

word_part_right_extend()

set_visible_policy()

del_line_left()

del_line_right()

grab_focus()

start_record()

stop_record()

set_lexer()
Define what kind of lexer language will be used to highlight the code.
get_lexer()
Return what kind of lexer language is used to highlight the code. See set_lexer() .
colourise()

set_property()

set_keywords()
Define the keywords list for some keywords set.
set_lexer_language()

Signals

"style_needed"

"char_added"
This signal is emitted when a character is added.
"save_point_reached"

"save_point_left"

"modify_attempt_ro"

"key"

"double_click"

"update_ui"
update_ui signal is emitted when the screen needs to be refreshed.
"modified"
modified signal is emitted when the user changes the text inside GtkScintilla text area, by adding or deleting some character.
"macro_record"

"margin_click"
margin_click signal is emitted when the users clicks on the margin of GtkScintilla object.
"need_shown"

"painted"

"user_list_selection"

"uri_dropped"

Prev	Home	Next
Scintilla Classes	Up	GtkScintilla Constructor

PHP-GTK Manual

GtkScintilla

Object Hierarchy

Direct subclasses

Description

Constructor

Methods

Signals

Newsletter

Hosted by

Search

Links