From ba429d344132c088177e853cce8ff7181570b221 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 10 Apr 2024 19:42:51 +0200 Subject: Adding upstream version 44.2. Signed-off-by: Daniel Baumann --- docs/reference/api-breaks.xml | 199 +++++++++++++++++++++++ docs/reference/gedit-docs.xml | 58 +++++++ docs/reference/gedit-sections.txt | 329 ++++++++++++++++++++++++++++++++++++++ docs/reference/meson.build | 42 +++++ 4 files changed, 628 insertions(+) create mode 100644 docs/reference/api-breaks.xml create mode 100644 docs/reference/gedit-docs.xml create mode 100644 docs/reference/gedit-sections.txt create mode 100644 docs/reference/meson.build (limited to 'docs/reference') diff --git a/docs/reference/api-breaks.xml b/docs/reference/api-breaks.xml new file mode 100644 index 0000000..8175564 --- /dev/null +++ b/docs/reference/api-breaks.xml @@ -0,0 +1,199 @@ + + +]> + + + API Breaks + + + gedit is a quite old piece of software (created in 1998, at the beginnings + of the GNOME project), and as every software, the code evolves during its + lifetime. So there are sometimes API breaks for gedit plugins, there are no + API stability guarantees. + + + + When it is possible, instead of directly removing an API, that API is first + marked as deprecated, and then removed for the next API break. See the + index of deprecated symbols. + + + + 43 -> 44 + + + + When an URI is added to the + GtkRecentManager, + the groups field of + GtkRecentData + is no longer set. You can rely on the application name instead. + + + + + The gedit_document_get_language() function has been + removed, use + gtk_source_buffer_get_language() + instead. + + + + + The gedit_document_get_short_name_for_display() function has been + removed, use + tepl_file_get_short_name() + instead. + + + + + The gedit_document_is_untitled() function has been + removed, use + tepl_file_get_location() + instead. + + + + + The gedit_statusbar_set_overwrite() + and gedit_statusbar_clear_overwrite() + functions have been removed. + + + + + + + 3.38 -> 40 + + + + All previously deprecated APIs have been removed. + + + + + The GeditProgressInfoBar class has been removed, you can + use TeplProgressInfoBar + instead. + + + + + GeditDocument is now a subclass + of TeplBuffer. + + + + + The GeditDocument::cursor-moved signal has been removed. + You can use the TeplBuffer API + instead. + + + + + The gedit_document_get_uri_for_display() function has + been removed from the public API. + + + + + The GeditDocument:shortname property has been removed. + You can use the TeplFile API instead. + + + + + The gedit_document_is_untouched() function has been + removed. You can use the TeplBuffer + API instead. + + + + + The gedit_view_set_font() function has been removed. + + + + + DEBUG_METADATA has been removed. + + + + + + + 3.36.0 -> 3.37.1 + + + + All previously deprecated APIs have been removed. + + + + + The lockdown support has been removed (for the + org.gnome.desktop.lockdown GSettings). So the + gedit_app_get_lockdown() function has been removed. + + + + + The GBOOLEAN_TO_POINTER() and + GPOINTER_TO_BOOLEAN() macros have been removed from + gedit-utils.h. + + + + + The gedit_utils_get_current_workspace(), + gedit_utils_get_window_workspace() and + gedit_utils_get_current_viewport() functions have been + removed because workspaces information is not available on Wayland. + + + + + + + 3.34.0 -> 3.35.2 + + + + All previously deprecated APIs have been removed. + + + + + The GeditDocument:use-gvfs-metadata property has been + removed. But there was anyway a warning for not using that property in + a gedit plugin. + + + + + For gedit_document_get_metadata() + and gedit_document_set_metadata(), + the key names should now have the prefix "gedit-" with + possibly an additional namespace for the plugin name, for example + "gedit-spell-foobar". So the key names are now the same + regardless of the operating system, and the key names should no longer + start with "metadata::". + + + + + + + For previous gedit versions + + See the + Old API Changes wiki page. + + + diff --git a/docs/reference/gedit-docs.xml b/docs/reference/gedit-docs.xml new file mode 100644 index 0000000..a0dc624 --- /dev/null +++ b/docs/reference/gedit-docs.xml @@ -0,0 +1,58 @@ + + + + + gedit Reference Manual + + + + API Reference + + + + + + + + + + + + + + + + + + + + + + Annexes + + + Object Hierarchy + + + + + + + Index of all symbols + + + + Index of deprecated symbols + + + + Index of new symbols in 3.4 + + + + Index of new symbols in 3.14 + + + + diff --git a/docs/reference/gedit-sections.txt b/docs/reference/gedit-sections.txt new file mode 100644 index 0000000..22922b4 --- /dev/null +++ b/docs/reference/gedit-sections.txt @@ -0,0 +1,329 @@ +
+gedit-app +GeditApp +GeditApp +gedit_app_create_window +gedit_app_set_window_title +gedit_app_get_main_windows +gedit_app_get_documents +gedit_app_get_views +gedit_app_process_window_event +gedit_app_show_help + +GEDIT_APP +GEDIT_IS_APP +GEDIT_TYPE_APP +gedit_app_get_type +GEDIT_APP_CLASS +GEDIT_IS_APP_CLASS +GEDIT_APP_GET_CLASS +
+ +
+gedit-app-activatable +GeditAppActivatable +GeditAppActivatable +gedit_app_activatable_activate +gedit_app_activatable_deactivate +gedit_app_activatable_extend_menu + +GEDIT_TYPE_APP_ACTIVATABLE +GEDIT_APP_ACTIVATABLE +GEDIT_APP_ACTIVATABLE_IFACE +GEDIT_IS_APP_ACTIVATABLE +GEDIT_APP_ACTIVATABLE_GET_IFACE +gedit_app_activatable_get_type +
+ +
+gedit-commands +GeditCommands +gedit_commands_load_location +gedit_commands_load_locations +gedit_commands_save_document +gedit_commands_save_document_async +gedit_commands_save_document_finish +gedit_commands_save_all_documents +
+ +
+gedit-document +GeditDocument +GeditDocument +gedit_document_new +gedit_document_get_file +gedit_document_get_mime_type +gedit_document_set_language +gedit_document_get_content_type +gedit_document_get_metadata +gedit_document_set_metadata +gedit_document_set_search_context +gedit_document_get_search_context + +GEDIT_DOCUMENT +GEDIT_IS_DOCUMENT +GEDIT_TYPE_DOCUMENT +gedit_document_get_type +GEDIT_DOCUMENT_CLASS +GEDIT_IS_DOCUMENT_CLASS +GEDIT_DOCUMENT_GET_CLASS +
+ +
+gedit-encodings-combo-box +GeditEncodingsComboBox +GeditEncodingsComboBox +gedit_encodings_combo_box_new +gedit_encodings_combo_box_get_selected_encoding +gedit_encodings_combo_box_set_selected_encoding + +GEDIT_ENCODINGS_COMBO_BOX +GEDIT_IS_ENCODINGS_COMBO_BOX +GEDIT_TYPE_ENCODINGS_COMBO_BOX +gedit_encodings_combo_box_get_type +GEDIT_ENCODINGS_COMBO_BOX_CLASS +GEDIT_IS_ENCODINGS_COMBO_BOX_CLASS +GEDIT_ENCODINGS_COMBO_BOX_GET_CLASS +
+ +
+gedit-message-bus +GeditMessageBus +GeditMessageBus +GeditMessageCallback +GeditMessageBusForeach +gedit_message_bus_get_default +gedit_message_bus_new +gedit_message_bus_lookup +gedit_message_bus_register +gedit_message_bus_unregister +gedit_message_bus_unregister_all +gedit_message_bus_is_registered +gedit_message_bus_foreach +gedit_message_bus_connect +gedit_message_bus_disconnect +gedit_message_bus_disconnect_by_func +gedit_message_bus_block +gedit_message_bus_block_by_func +gedit_message_bus_unblock +gedit_message_bus_unblock_by_func +gedit_message_bus_send_message +gedit_message_bus_send_message_sync +gedit_message_bus_send +gedit_message_bus_send_sync + +GEDIT_MESSAGE_BUS +GEDIT_MESSAGE_BUS_CONST +GEDIT_IS_MESSAGE_BUS +GEDIT_TYPE_MESSAGE_BUS +gedit_message_bus_get_type +GEDIT_MESSAGE_BUS_CLASS +GEDIT_IS_MESSAGE_BUS_CLASS +GEDIT_MESSAGE_BUS_GET_CLASS +GeditMessageBusPrivate +
+ +
+gedit-message +GeditMessage +GeditMessage +gedit_message_get_object_path +gedit_message_get_method +gedit_message_type_has +gedit_message_type_check +gedit_message_has +gedit_message_is_valid_object_path +gedit_message_type_identifier + +GEDIT_MESSAGE +GEDIT_MESSAGE_CONST +GEDIT_IS_MESSAGE +GEDIT_TYPE_MESSAGE +gedit_message_get_type +GEDIT_MESSAGE_CLASS +GEDIT_IS_MESSAGE_CLASS +GEDIT_MESSAGE_GET_CLASS +GeditMessagePrivate +
+ +
+gedit-statusbar +GeditStatusbar +GeditStatusbar +gedit_statusbar_new +gedit_statusbar_set_window_state +gedit_statusbar_flash_message + +GEDIT_STATUSBAR +GEDIT_IS_STATUSBAR +GEDIT_TYPE_STATUSBAR +gedit_statusbar_get_type +GEDIT_STATUSBAR_CLASS +GEDIT_IS_STATUSBAR_CLASS +GEDIT_STATUSBAR_GET_CLASS +
+ +
+gedit-tab +GeditTab +GeditTab +GeditTabState +gedit_tab_get_view +gedit_tab_get_document +gedit_tab_get_from_document +gedit_tab_get_state +gedit_tab_get_auto_save_enabled +gedit_tab_set_auto_save_enabled +gedit_tab_get_auto_save_interval +gedit_tab_set_auto_save_interval +gedit_tab_set_info_bar + +GEDIT_TAB +GEDIT_IS_TAB +GEDIT_TYPE_TAB +gedit_tab_get_type +GEDIT_TAB_CLASS +GEDIT_IS_TAB_CLASS +GEDIT_TAB_GET_CLASS +GEDIT_TYPE_TAB_STATE +gedit_tab_state_get_type +
+ +
+gedit-view +GeditViewPrivate +GeditView +GeditView +gedit_view_new + +GEDIT_VIEW +GEDIT_IS_VIEW +GEDIT_TYPE_VIEW +gedit_view_get_type +GEDIT_VIEW_CLASS +GEDIT_IS_VIEW_CLASS +GEDIT_VIEW_GET_CLASS +
+ +
+gedit-view-activatable +GeditViewActivatable +GeditViewActivatable +gedit_view_activatable_activate +gedit_view_activatable_deactivate + +GEDIT_TYPE_VIEW_ACTIVATABLE +GEDIT_VIEW_ACTIVATABLE +GEDIT_VIEW_ACTIVATABLE_IFACE +GEDIT_IS_VIEW_ACTIVATABLE +GEDIT_VIEW_ACTIVATABLE_GET_IFACE +gedit_view_activatable_get_type +
+ +
+gedit-window +GeditWindow +GeditWindow +GeditWindowState +gedit_window_create_tab +gedit_window_create_tab_from_location +gedit_window_create_tab_from_stream +gedit_window_close_tab +gedit_window_close_all_tabs +gedit_window_close_tabs +gedit_window_get_active_tab +gedit_window_set_active_tab +gedit_window_get_active_view +gedit_window_get_active_document +gedit_window_get_documents +gedit_window_get_unsaved_documents +gedit_window_get_views +gedit_window_get_group +gedit_window_get_side_panel +gedit_window_get_bottom_panel +gedit_window_get_statusbar +gedit_window_get_state +gedit_window_get_tab_from_location +gedit_window_get_message_bus + +GEDIT_WINDOW +GEDIT_IS_WINDOW +GEDIT_TYPE_WINDOW +gedit_window_get_type +GEDIT_WINDOW_CLASS +GEDIT_IS_WINDOW_CLASS +GEDIT_WINDOW_GET_CLASS +GEDIT_TYPE_WINDOW_STATE +GeditWindowPrivate +gedit_window_state_get_type +
+ +
+gedit-window-activatable +GeditWindowActivatable +GeditWindowActivatable +gedit_window_activatable_activate +gedit_window_activatable_deactivate +gedit_window_activatable_update_state + +GEDIT_TYPE_WINDOW_ACTIVATABLE +GEDIT_WINDOW_ACTIVATABLE +GEDIT_WINDOW_ACTIVATABLE_IFACE +GEDIT_IS_WINDOW_ACTIVATABLE +GEDIT_WINDOW_ACTIVATABLE_GET_IFACE +gedit_window_activatable_get_type +
+ +
+gedit-debug +GeditDebugSection +DEBUG_VIEW +DEBUG_PREFS +DEBUG_WINDOW +DEBUG_PANEL +DEBUG_PLUGINS +DEBUG_TAB +DEBUG_DOCUMENT +DEBUG_COMMANDS +DEBUG_APP +DEBUG_UTILS +gedit_debug_init +gedit_debug +gedit_debug_message +gedit_debug_plugin_message + +GEDIT_TYPE_DEBUG_SECTION +gedit_debug_section_get_type +
+ +
+gedit-menu-extension +GeditMenuExtension +gedit_menu_extension_new +gedit_menu_extension_append_menu_item +gedit_menu_extension_prepend_menu_item +gedit_menu_extension_remove_items + +GEDIT_IS_MENU_EXTENSION +GEDIT_IS_MENU_EXTENSION_CLASS +GEDIT_MENU_EXTENSION +GEDIT_MENU_EXTENSION_CLASS +GEDIT_MENU_EXTENSION_CONST +GEDIT_MENU_EXTENSION_GET_CLASS +GEDIT_TYPE_MENU_EXTENSION +GeditMenuExtensionClass +gedit_menu_extension_get_type +
+ +
+gedit-utils +gedit_utils_menu_position_under_tree_view +gedit_utils_set_atk_name_description +gedit_utils_basename_for_display +gedit_utils_drop_get_uris +gedit_utils_get_compression_type_from_content_type +gedit_utils_is_valid_location +gedit_utils_location_get_dirname_for_display +gedit_utils_set_direct_save_filename +gedit_utils_newline_type_to_string +
diff --git a/docs/reference/meson.build b/docs/reference/meson.build new file mode 100644 index 0000000..9a9c414 --- /dev/null +++ b/docs/reference/meson.build @@ -0,0 +1,42 @@ +html_dir = get_option('prefix') / gnome.gtkdoc_html_dir('gedit') + +glib_docpath = dependency('glib-2.0').get_pkgconfig_variable('prefix') / 'share/gtk-doc/html/glib' +gobject_docpath = dependency('gobject-2.0').get_pkgconfig_variable('prefix') / 'share/gtk-doc/html/gobject' +gio_docpath = dependency('gio-2.0').get_pkgconfig_variable('prefix') / 'share/gtk-doc/html/gio' +gdk_docpath = dependency('gdk-3.0').get_pkgconfig_variable('prefix') / 'share/gtk-doc/html/gdk3' +gtk_docpath = dependency('gtk+-3.0').get_pkgconfig_variable('prefix') / 'share/gtk-doc/html/gtk3' +gsv_docpath = dependency('gtksourceview-4').get_pkgconfig_variable('prefix') / 'share/gtk-doc/html/gtksourceview-4.0' +amtk_docpath = dependency('amtk-5').get_pkgconfig_variable('prefix') / 'share/gtk-doc/html/amtk-5' +tepl_docpath = dependency('tepl-6').get_pkgconfig_variable('prefix') / 'share/gtk-doc/html/tepl-6' +libpeas_docpath = dependency('libpeas-1.0').get_pkgconfig_variable('prefix') / 'share/gtk-doc/html/libpeas' + +gedit_doc_dep = declare_dependency( + link_with: libgedit_shared_lib, + include_directories: root_include_dir, + dependencies: deps_basic_list, +) + +gnome.gtkdoc( + 'gedit', + main_xml: 'gedit-docs.xml', + src_dir: include_directories('../../gedit/'), + dependencies: gedit_doc_dep, + scan_args: ['--rebuild-types'], + fixxref_args: [ + '--html-dir=@0@'.format(html_dir), + '--extra-dir=@0@'.format(glib_docpath), + '--extra-dir=@0@'.format(gobject_docpath), + '--extra-dir=@0@'.format(gio_docpath), + '--extra-dir=@0@'.format(gdk_docpath), + '--extra-dir=@0@'.format(gtk_docpath), + '--extra-dir=@0@'.format(gsv_docpath), + '--extra-dir=@0@'.format(amtk_docpath), + '--extra-dir=@0@'.format(tepl_docpath), + '--extra-dir=@0@'.format(libpeas_docpath), + ], + content_files: [ + 'api-breaks.xml' + ], + ignore_headers: libgedit_private_headers, + install: true, +) -- cgit v1.2.3