|
geany
1.38
About: Geany is a text editor (using GTK2) with basic features of an integrated development environment (syntax highlighting, code folding, symbol name auto-completion, ...). F: office T: editor programming GTK+ IDE
 Fossies Dox: geany-1.38.tar.bz2 ("unofficial" and yet experimental doxygen-generated source code documentation)  |
Structure for representing an open tab with all its properties. More...
#include <document.h>
Public Attributes | |
| gboolean | is_valid |
| Flag used to check if this document is valid when iterating GeanyData::documents_array. More... | |
| gint | index |
| Index in the documents array. More... | |
| gboolean | has_tags |
| Whether this document supports source code symbols(tags) to show in the sidebar. More... | |
| gchar * | file_name |
| The UTF-8 encoded file name. More... | |
| gchar * | encoding |
| The encoding of the document, must be a valid string representation of an encoding, can be retrieved with encodings_get_charset_from_index. More... | |
| gboolean | has_bom |
| Internally used flag to indicate whether the file of this document has a byte-order-mark. More... | |
| GeanyEditor * | editor |
| The editor associated with the document. More... | |
| GeanyFiletype * | file_type |
| The filetype for this document, it's only a reference to one of the elements of the global filetypes array. More... | |
| TMSourceFile * | tm_file |
TMSourceFile object for this document, or NULL. More... | |
| gboolean | readonly |
| Whether this document is read-only. More... | |
| gboolean | changed |
| Whether this document has been changed since it was last saved. More... | |
| gchar * | real_path |
| The link-dereferenced, locale-encoded file name. More... | |
| guint | id |
| A pseudo-unique ID for this document. More... | |
| struct GeanyDocumentPrivate * | priv |
Structure for representing an open tab with all its properties.
Definition at line 80 of file document.h.
| gboolean GeanyDocument::changed |
Whether this document has been changed since it was last saved.
Definition at line 107 of file document.h.
Referenced by create_statusbar_statistics(), document_account_for_unsaved(), document_create(), document_get_status_id(), document_redo_add(), document_reload_prompt(), document_save_file(), document_set_text_changed(), document_undo_add_internal(), get_current_tag_name(), goto_compiler_file_line(), have_session_docs(), monitor_reload_file(), on_build_menu_item(), on_monitor_reload_file_response(), on_notebook1_switch_page_after(), on_prefs_dialog_response(), on_reload_all(), on_save_all1_activate(), remove_page(), replace_in_session(), toolbar_reload(), ui_set_window_title(), and update_changed_state().
| GeanyEditor* GeanyDocument::editor |
The editor associated with the document.
Definition at line 98 of file document.h.
Referenced by begin_print(), build_replace_placeholder(), cb_func_document_action(), cb_func_editor_action(), cb_func_format_action(), cb_func_goto_action(), cb_func_insert_action(), cb_func_search_action(), cb_func_select_action(), cb_func_switch_action(), check_menu_key(), check_snippet_completion(), convert_eol(), convert_eol_characters(), create_statusbar_statistics(), delay_match_brace(), do_select_current(), document_apply_indent_settings(), document_can_redo(), document_can_undo(), document_clone(), document_create(), document_detect_indent_type(), document_detect_indent_width(), document_find_text(), document_get_notebook_child(), document_get_status_color(), document_grab_focus(), document_highlight_tags(), document_load_config(), document_new_file(), document_open_file_full(), document_redo(), document_reload_force(), document_replace_all(), document_replace_range(), document_replace_sel(), document_replace_text(), document_save_file(), document_save_file_as(), document_search_bar_find(), document_set_filetype(), document_try_focus(), document_undo(), document_undo_clear(), document_update_tags(), editor_create(), enable_key_intercept(), filetypes_detect_from_document(), find_document_usage(), find_usage(), focus_sci(), get_current_tag_name(), get_current_tag_name_cached(), get_current_word_or_sel(), get_line_column_from_pos(), get_line_number_width(), get_session_file_string(), get_symbol_tooltip(), goto_compiler_file_line(), goto_file_pos(), goto_matching_brace(), goto_tag(), insert_comment_template(), insert_date(), insert_include(), insert_multiline_comment(), msgwin_goto_messages_file_line(), navqueue_go_back(), navqueue_goto_line(), on_color_dialog_response(), on_comments_changelog_activate(), on_comments_fileheader_activate(), on_comments_function_activate(), on_config_file_clicked(), on_context_action1_activate(), on_detect_type_from_file_activate(), on_detect_width_from_file_activate(), on_doc_menu_item_clicked(), on_document_close(), on_document_filetype_set(), on_document_save(), on_go_to_line_activate(), on_indent_width_activate(), on_line_breaking1_activate(), on_line_wrapping1_toggled(), on_menu_comment_line1_activate(), on_menu_decrease_indent1_activate(), on_menu_fold_all1_activate(), on_menu_increase_indent1_activate(), on_menu_open_selected_file1_activate(), on_menu_remove_indicators1_activate(), on_menu_toggle_line_commentation1_activate(), on_menu_uncomment_line1_activate(), on_menu_unfold_all1_activate(), on_normal_size1_activate(), on_redo1_activate(), on_refresh(), on_remove_markers1_activate(), on_replace_spaces_activate(), on_replace_tabs_activate(), on_set_file_readonly1_toggled(), on_show_color_chooser1_activate(), on_snippet_keybinding_activate(), on_strip_trailing_spaces1_activate(), on_toggle_case1_activate(), on_toolbutton_goto_entry_activate(), on_undo1_activate(), on_use_auto_indentation1_toggled(), on_zoom_in1_activate(), on_zoom_out1_activate(), open_session_file(), process_build_output_line(), protect_document(), queue_colourise(), read_current_word(), remove_page(), replace_header_filename(), replace_special_character(), reshow_calltip(), save_convert_to_encoding(), sc_insert(), search_find_again(), search_find_selection(), search_mark_all(), search_show_find_dialog(), search_show_find_in_files_dialog_full(), search_show_replace_dialog(), set_indent_type(), show_goto_popup(), split_view(), tools_execute_custom_command(), tools_word_count(), ui_document_show_hide(), ui_toggle_editor_features(), ui_update_menu_copy_items(), ui_update_popup_copy_items(), ui_update_statusbar(), unprotect_document(), update_changed_state(), write_html_file(), and write_latex_file().
| gchar* GeanyDocument::encoding |
The encoding of the document, must be a valid string representation of an encoding, can be retrieved with encodings_get_charset_from_index.
Definition at line 95 of file document.h.
Referenced by create_statusbar_statistics(), dialogs_show_file_properties(), document_clone(), document_new_file(), document_open_file_full(), document_redo(), document_reload_prompt(), document_save_file(), document_set_encoding(), document_set_filetype(), document_undo(), encodings_radio_item_change_cb(), get_session_file_string(), get_symbol_name(), get_symbol_tooltip(), monitor_reload_file(), on_keep_edit_history_on_reload_response(), on_monitor_reload_file_response(), remove_page(), save_convert_to_encoding(), search_show_find_in_files_dialog_full(), store_saved_encoding(), ui_document_show_hide(), and update_changed_state().
| gchar* GeanyDocument::file_name |
The UTF-8 encoded file name.
Be careful; glibc and GLib file functions expect the locale representation of the file name which can be different from this. For conversion into locale encoding, you can use utils_get_locale_from_utf8().
Definition at line 92 of file document.h.
Referenced by auto_save(), backupcopy_document_save_cb(), build_menu_update(), build_replace_placeholder(), build_run_cmd(), build_spawn_cmd(), create_file_save_as_dialog(), dialogs_show_file_properties(), document_activate_cb(), document_check_disk_status(), document_create(), document_find_by_filename(), document_need_save_as(), document_open_file_full(), document_reload_prompt(), document_rename_file(), document_save_file(), document_save_file_as(), document_set_filetype(), document_update_tags(), filetypes_detect_from_document(), get_doc_parent(), get_session_file_string(), handle_save_as(), have_session_docs(), instantsave_document_new_cb(), monitor_file_setup(), monitor_reload_file(), monitor_resave_missing_file(), navqueue_go_back(), navqueue_goto_line(), on_build_menu_item(), on_comments_fileheader_activate(), on_current_path(), on_document_focus_out(), on_notebook1_switch_page_after(), on_open_in_new_window_activate(), parse_file_line(), print_external(), printing_print_gtk(), remove_page(), replace_header_filename(), save_file_handle_infobars(), save_on_focus_out_idle(), show_save_as_gtk(), snippets_make_replacements(), ui_add_recent_document(), ui_set_window_title(), and utils_get_current_file_dir_utf8().
| GeanyFiletype* GeanyDocument::file_type |
The filetype for this document, it's only a reference to one of the elements of the global filetypes array.
Definition at line 101 of file document.h.
Referenced by add_top_level_items(), autocomplete_check_html(), autocomplete_scope(), begin_print(), build_add_dialog_row(), build_get_regex(), build_keybinding(), build_run_cmd(), build_spawn_cmd(), close_block(), create_statusbar_statistics(), dialogs_show_file_properties(), document_apply_indent_settings(), document_clone(), document_highlight_tags(), document_load_config(), document_reload_config(), document_reload_force(), document_save_file(), document_save_file_as(), document_set_filetype(), document_update_tag_list_in_idle(), document_update_tags(), editor_do_comment(), editor_do_comment_toggle(), editor_do_uncomment(), editor_find_snippet(), editor_get_calltip_text(), editor_get_filetype_at_line(), editor_insert_multiline_comment(), editor_show_calltip(), editor_start_auto_complete(), editor_strip_line_trailing_spaces(), filetypes_parse_error_message(), filetypes_reload_extensions(), get_build_group_pointer(), get_current_tag_name(), get_function_fold_number(), get_indent_size_after_line(), get_next_build_cmd(), get_session_file_string(), get_symbol_name(), goto_tag(), highlighting_show_color_scheme_dialog(), insert_build_page(), insert_multiline_comment(), instantsave_document_new_cb(), on_comments_fileheader_activate(), on_comments_function_activate(), on_context_action1_activate(), on_snippet_keybinding_activate(), printfcmds(), real_comment_multiline(), real_uncomment_multiline(), replace_header_filename(), show_build_commands_dialog(), show_save_as_gtk(), sidebar_openfiles_add(), sidebar_openfiles_update(), sidebar_update_tag_list(), snippets_complete_constructs(), snippets_make_replacements(), symbols_get_current_scope(), sync_to_current(), templates_get_template_changelog(), templates_get_template_function(), templates_get_template_licence(), ui_add_recent_document(), ui_document_show_hide(), ui_menu_add_document_items_sorted(), ui_update_insert_include_item(), and update_config().
| gboolean GeanyDocument::has_bom |
Internally used flag to indicate whether the file of this document has a byte-order-mark.
Definition at line 97 of file document.h.
Referenced by create_statusbar_statistics(), dialogs_show_file_properties(), document_clone(), document_open_file_full(), document_redo(), document_save_file(), document_undo(), on_menu_write_unicode_bom1_toggled(), store_saved_encoding(), ui_document_show_hide(), and update_changed_state().
| gboolean GeanyDocument::has_tags |
Whether this document supports source code symbols(tags) to show in the sidebar.
Definition at line 86 of file document.h.
Referenced by on_symbol_tree_menu_show(), on_symbol_tree_sort_clicked(), and sidebar_update_tag_list().
| guint GeanyDocument::id |
A pseudo-unique ID for this document.
0 is reserved as an unused value.
Definition at line 119 of file document.h.
Referenced by document_create(), msgwin_msg_add_string(), and remove_page().
| gint GeanyDocument::index |
Index in the documents array.
Definition at line 84 of file document.h.
Referenced by document_create().
| gboolean GeanyDocument::is_valid |
Flag used to check if this document is valid when iterating GeanyData::documents_array.
Definition at line 83 of file document.h.
Referenced by build_add_dialog_row(), build_menu_update(), build_replace_placeholder(), build_spawn_cmd(), check_menu_key(), convert_eol_characters(), dialogs_show_file_properties(), document_create(), document_find_by_filename(), document_find_by_real_path(), document_list_changed_cb(), document_open_file_full(), filetypes_detect_from_document(), get_current_tag_name_cached(), get_next_build_cmd(), navqueue_goto_line(), on_close_other_documents1_activate(), on_doc_menu_item_clicked(), on_open_in_new_window_activate(), remove_page(), sidebar_update_tag_list(), ui_document_show_hide(), ui_set_window_title(), ui_update_insert_include_item(), ui_update_menu_copy_items(), ui_update_popup_copy_items(), ui_update_popup_reundo_items(), and ui_update_statusbar().
| struct GeanyDocumentPrivate* GeanyDocument::priv |
Definition at line 121 of file document.h.
Referenced by add_top_level_items(), auto_update_margin_width(), check_menu_key(), document_can_redo(), document_can_undo(), document_check_disk_status(), document_clone(), document_create(), document_get_data(), document_get_status_id(), document_highlight_tags(), document_load_config(), document_new_file(), document_open_file_full(), document_redo(), document_redo_add(), document_reload_force(), document_save_file(), document_save_file_as(), document_set_data(), document_set_data_full(), document_stop_file_monitoring(), document_try_focus(), document_undo(), document_undo_add(), document_undo_add_internal(), document_undo_clear(), document_update_tab_label(), document_update_tag_list_in_idle(), document_update_timestamp(), editor_check_colourise(), monitor_file_setup(), monitor_reload_file(), monitor_resave_missing_file(), on_document_update_tag_list_idle(), on_expand_collapse(), on_find_usage(), on_keep_edit_history_on_reload_response(), on_monitor_reload_file_response(), on_monitor_resave_missing_file_response(), on_prefs_font_choosed(), on_symbol_tree_menu_show(), openfiles_remove(), protect_document(), queue_colourise(), remove_doc_data(), remove_each_doc_data(), remove_page(), save_doc(), save_file_handle_infobars(), sidebar_openfiles_add(), sidebar_openfiles_update(), sidebar_remove_document(), sidebar_update_tag_list(), store_saved_encoding(), symbols_recreate_tag_list(), ui_update_tab_status(), unprotect_document(), update_changed_state(), and update_tree_tags().
| gboolean GeanyDocument::readonly |
Whether this document is read-only.
Definition at line 105 of file document.h.
Referenced by create_statusbar_statistics(), dialogs_show_file_properties(), document_clone(), document_get_status_id(), document_open_file_full(), document_reload_force(), document_replace_range(), document_save_file(), document_save_file_as(), encodings_radio_item_change_cb(), get_session_file_string(), on_menu_write_unicode_bom1_toggled(), on_set_file_readonly1_toggled(), ui_document_show_hide(), and unprotect_document().
| gchar* GeanyDocument::real_path |
The link-dereferenced, locale-encoded file name.
If non-NULL, this indicates the file once existed on disk (not just as an unsaved document with a filename set).
Definition at line 115 of file document.h.
Referenced by configuration_save_session_files(), create_save_file_dialog(), document_activate_cb(), document_check_disk_status(), document_find_by_real_path(), document_open_file_full(), document_save_file(), document_save_file_as(), documents_menu_update(), find_best_goto_tag(), monitor_resave_missing_file(), on_document_save(), on_notebook1_switch_page_after(), remove_page(), save_doc(), and show_tab_bar_popup_menu().
| TMSourceFile* GeanyDocument::tm_file |
TMSourceFile object for this document, or NULL.
Definition at line 103 of file document.h.
Referenced by autocomplete_scope(), document_load_config(), document_update_tags(), get_current_tag_name(), get_tag_list(), goto_tag(), handle_save_as(), and remove_page().
1.9.3