diff options
| author | Juan Pablo Ugarte <jpu@src.gnome.org> | 2007-07-30 19:56:51 +0000 |
|---|---|---|
| committer | Juan Pablo Ugarte <jpu@src.gnome.org> | 2007-07-30 19:56:51 +0000 |
| commit | 2d57d53ffcff70bb136f3595583f9df3b1a533ff (patch) | |
| tree | 2f70ab244a9cd4097664f8f8e20e7f1d1316920d /doc | |
| parent | e6e03f1bc45f45d4a025009e02003ef595e26577 (diff) | |
| download | glade-2d57d53ffcff70bb136f3595583f9df3b1a533ff.tar.gz | |
removed every extra documentation, we keep them empty just because
* doc/tmpl/*.sgml: removed every extra documentation, we keep them empty just
because otherwise the build fails.
* doc/gladeui-docs.sgml, doc/gladeui-sections.txt, doc/gladeui.types: updated
(GladeWidgetClass replaced by GladeWidgetAdaptor)
* gladeui/glade-editor.c, gladeui/glade-editor-property.c, gladeui/glade-parameter.c,
gladeui/glade-widget.c, gladeui/glade-fixed.c, gladeui/glade-clipboard.c,
gladeui/glade-inspector.[ch], gladeui/glade-widget-adaptor.[ch], gladeui/glade-command.c,
gladeui/glade-command.h, gladeui/glade-base-editor.[ch], gladeui/glade-palette.[ch],
gladeui/glade-utils.c, gladeui/glade-signal-editor.c, gladeui/glade-app.c,
gladeui/glade-placeholder.c, gladeui/glade-property.c, gladeui/glade-property-class.c,
gladeui/glade-project.c, gladeui/glade-clipboard-view.c:
Added section's short and long description. (moved from tmpl)
svn path=/trunk/; revision=1523
Diffstat (limited to 'doc')
27 files changed, 2377 insertions, 913 deletions
diff --git a/doc/gladeui-docs.sgml b/doc/gladeui-docs.sgml index 1d60c4d1..7ef577fd 100644 --- a/doc/gladeui-docs.sgml +++ b/doc/gladeui-docs.sgml @@ -20,7 +20,7 @@ <!ENTITY GladeProperty SYSTEM "xml/glade-property.xml"> <!ENTITY GladeSignalEditor SYSTEM "xml/glade-signal-editor.xml"> <!ENTITY GladeUtils SYSTEM "xml/glade-utils.xml"> -<!ENTITY GladeWidgetClass SYSTEM "xml/glade-widget-class.xml"> +<!ENTITY GladeWidgetAdaptor SYSTEM "xml/glade-widget-adaptor.xml"> <!ENTITY GladeWidget SYSTEM "xml/glade-widget.xml"> <!ENTITY GladeFixed SYSTEM "xml/glade-fixed.xml"> <!ENTITY GladeBaseEditor SYSTEM "xml/glade-base-editor.xml"> @@ -62,7 +62,7 @@ &GladeWidget; &GladeFixed; &GladeProperty; - &GladeWidgetClass; + &GladeWidgetAdaptor; &GladePropertyClass; &GladeCommand; &GladeClipboard; diff --git a/doc/gladeui-sections.txt b/doc/gladeui-sections.txt index db349b59..19ea411a 100644 --- a/doc/gladeui-sections.txt +++ b/doc/gladeui-sections.txt @@ -1,80 +1,210 @@ -<INCLUDE>gladeui/glade.h</INCLUDE> +<SECTION> +<FILE>glade-widget</FILE> +<TITLE>GladeWidget</TITLE> +GladeWidget +glade_widget_get_from_gobject +glade_widget_add_child +glade_widget_remove_child +glade_widget_write +glade_widget_read +glade_widget_replace +glade_widget_rebuild +glade_widget_dup +glade_widget_copy_signals +glade_widget_copy_properties +glade_widget_set_packing_properties +glade_widget_get_property +glade_widget_get_pack_property +glade_widget_dup_properties +glade_widget_remove_property +glade_widget_show +glade_widget_hide +glade_widget_add_signal_handler +glade_widget_remove_signal_handler +glade_widget_change_signal_handler +glade_widget_list_signal_handlers +glade_widget_has_decendant +glade_widget_event +glade_widget_placeholder_relation +glade_widget_get_action +glade_widget_get_pack_action +glade_widget_set_action_sensitive +glade_widget_set_pack_action_sensitive +glade_widget_remove_action +glade_widget_remove_pack_action +glade_widget_create_action_menu +glade_widget_project_notify +glade_widget_add_prop_ref +glade_widget_remove_prop_ref +glade_widget_object_set_property +glade_widget_object_get_property +glade_widget_child_set_property +glade_widget_child_get_property +glade_widget_property_get +glade_widget_property_set +glade_widget_pack_property_get +glade_widget_pack_property_set +glade_widget_property_reset +glade_widget_pack_property_reset +glade_widget_property_default +glade_widget_property_original_default +glade_widget_pack_property_default +glade_widget_property_set_sensitive +glade_widget_pack_property_set_sensitive +glade_widget_property_set_enabled +glade_widget_pack_property_set_enabled +glade_widget_property_set_save_always +glade_widget_pack_property_set_save_always +glade_widget_property_string +glade_widget_pack_property_string +glade_widget_set_name +glade_widget_get_name +glade_widget_set_internal +glade_widget_get_internal +glade_widget_set_object +glade_widget_get_object +glade_widget_set_project +glade_widget_get_project +glade_widget_get_adaptor +glade_widget_get_parent +glade_widget_set_parent +glade_widget_superuser +glade_widget_push_superuser +glade_widget_pop_superuser +<SUBSECTION Standard> +GLADE_WIDGET +GLADE_IS_WIDGET +GLADE_TYPE_WIDGET +glade_widget_get_type +GLADE_WIDGET_CLASS +GLADE_IS_WIDGET_CLASS +GLADE_WIDGET_GET_CLASS +</SECTION> <SECTION> -<FILE>glade-app</FILE> -<TITLE>GladeApp</TITLE> -GladeApp -glade_app_get -glade_app_update_ui -glade_app_set_window -glade_app_get_window -glade_app_get_editor -glade_app_get_palette -glade_app_get_clipboard -glade_app_get_clipboard_view -glade_app_set_project -glade_app_get_project -glade_app_add_project -glade_app_remove_project -glade_app_get_project_by_path -glade_app_get_projects -glade_app_get_config -glade_app_is_project_loaded -glade_app_show_properties -glade_app_hide_properties -glade_app_add_project_view -glade_app_command_undo -glade_app_command_redo -glade_app_command_copy -glade_app_command_cut -glade_app_command_paste -glade_app_command_delete -glade_app_command_delete_clipboard -glade_app_config_save -glade_app_set_transient_parent -glade_app_get_transient_parent -glade_app_set_accel_group -glade_app_update_instance_count -glade_app_undo_button_new -glade_app_redo_button_new -glade_app_selection_add -glade_app_selection_remove -glade_app_selection_changed -glade_app_get_selection -glade_app_selection_clear -glade_app_selection_set -glade_app_is_selected +<FILE>glade-widget-adaptor</FILE> +GladeWidgetAdaptorPrivate +GWA_IS_FIXED +GWA_IS_TOPLEVEL +GWA_USE_PLACEHOLDERS +GWA_DEFAULT_WIDTH +GWA_DEFAULT_HEIGHT +GWA_GET_CLASS +GWA_GET_OCLASS +GLADE_VALID_CREATE_REASON +GladeCreateReason +GLADE_TYPE_CREATE_REASON +GladeSetPropertyFunc +GladeGetPropertyFunc +GladeVerifyPropertyFunc +GladeChildSetPropertyFunc +GladeChildGetPropertyFunc +GladeChildVerifyPropertyFunc +GladeGetChildrenFunc +GladeAddChildFunc +GladeRemoveChildFunc +GladeReplaceChildFunc +GladePostCreateFunc +GladeGetInternalFunc +GladeActionActivateFunc +GladeChildActionActivateFunc +<TITLE>GladeSignal</TITLE> +<TITLE>GladeWidgetAdaptor</TITLE> +GladeWidgetAdaptor +glade_widget_adaptor_create_widget +glade_widget_adaptor_from_pclass +glade_widget_adaptor_from_pspec +glade_create_reason_get_type +glade_widget_adaptor_from_catalog +glade_widget_adaptor_register +glade_widget_adaptor_create_internal +glade_widget_adaptor_create_widget_real +glade_widget_adaptor_get_by_name +glade_widget_adaptor_get_by_type +glade_widget_adaptor_get_property_class +glade_widget_adaptor_get_pack_property_class +glade_widget_adaptor_default_params +glade_widget_adaptor_post_create +glade_widget_adaptor_get_internal_child +glade_widget_adaptor_set_property +glade_widget_adaptor_get_property +glade_widget_adaptor_verify_property +glade_widget_adaptor_add +glade_widget_adaptor_remove +glade_widget_adaptor_get_children +glade_widget_adaptor_has_child +glade_widget_adaptor_child_set_property +glade_widget_adaptor_child_get_property +glade_widget_adaptor_child_verify_property +glade_widget_adaptor_replace_child +glade_widget_adaptor_query +glade_widget_adaptor_get_packing_default +glade_widget_adaptor_is_container +glade_widget_adaptor_action_add +glade_widget_adaptor_pack_action_add +glade_widget_adaptor_action_remove +glade_widget_adaptor_pack_action_remove +glade_widget_adaptor_pack_actions_new +glade_widget_adaptor_action_activate +glade_widget_adaptor_child_action_activate <SUBSECTION Standard> -GLADE_APP -GLADE_IS_APP -GLADE_TYPE_APP -glade_app_get_type -GLADE_APP_CLASS -GLADE_IS_APP_CLASS -GLADE_APP_GET_CLASS -GladeAppClass -<SUBSECTION Private> -GLADE_CONFIG_FILENAME -GladeAppPriv +GLADE_WIDGET_ADAPTOR +GLADE_IS_WIDGET_ADAPTOR +GLADE_TYPE_WIDGET_ADAPTOR +glade_widget_adaptor_get_type +GLADE_WIDGET_ADAPTOR_CLASS +GLADE_IS_WIDGET_ADAPTOR_CLASS +GLADE_WIDGET_ADAPTOR_GET_CLASS </SECTION> <SECTION> -<FILE>glade-clipboard-view</FILE> -<TITLE>GladeClipboardView</TITLE> -GladeClipboardView -glade_clipboard_view_new -glade_clipboard_view_add -glade_clipboard_view_remove -glade_clipboard_view_refresh_sel +<FILE>glade-design-view</FILE> +GladeDesignViewPrivate +<TITLE>GladeDesignView</TITLE> +GladeDesignView +glade_design_view_new +glade_design_view_get_project +glade_design_view_get_from_project +glade_design_view_get_layout <SUBSECTION Standard> -GLADE_CLIPBOARD_VIEW -GLADE_IS_CLIPBOARD_VIEW -GLADE_TYPE_CLIPBOARD_VIEW -glade_clipboard_view_get_type -GLADE_CLIPBOARD_VIEW_CLASS -GLADE_IS_CLIPBOARD_VIEW_CLASS -GLADE_CLIPBOARD_VIEW_GET_CLASS -GladeClipboardViewClass +GLADE_DESIGN_VIEW +GLADE_IS_DESIGN_VIEW +GLADE_TYPE_DESIGN_VIEW +glade_design_view_get_type +GLADE_DESIGN_VIEW_CLASS +GLADE_IS_DESIGN_VIEW_CLASS +GLADE_DESIGN_VIEW_GET_CLASS +</SECTION> + +<SECTION> +<FILE>glade-property-class</FILE> +GPC_OBJECT_DELIMITER +GPC_PROPERTY_NAMELEN +GPCType +<TITLE>GladePropertyClass</TITLE> +glade_property_class_new +glade_property_class_new_from_spec +glade_property_class_list_atk_relations +glade_property_class_accel_property +glade_property_class_clone +glade_property_class_free +glade_property_class_is_visible +glade_property_class_is_object +glade_property_class_make_gvalue_from_string +glade_property_class_make_string_from_gvalue +glade_property_class_make_gvalue_from_vl +glade_property_class_set_vl_from_gvalue +glade_property_class_make_gvalue +glade_property_class_get_from_gvalue +glade_property_class_update_from_node +glade_property_class_get_displayable_value +glade_property_class_make_adjustment +glade_property_class_match +glade_property_class_void_value +glade_property_class_atk_realname +<SUBSECTION Standard> +GLADE_PROPERTY_CLASS +GLADE_IS_PROPERTY_CLASS </SECTION> <SECTION> @@ -93,41 +223,37 @@ GLADE_CLIPBOARD GLADE_IS_CLIPBOARD GLADE_TYPE_CLIPBOARD glade_clipboard_get_type -GladeClipboardClass </SECTION> <SECTION> -<FILE>glade-command</FILE> -<TITLE>GladeCommand</TITLE> -glade_command_execute -glade_command_undo -glade_command_unifies -glade_command_collapse -glade_command_push_group -glade_command_pop_group -glade_command_set_name -glade_command_create -glade_command_delete -GCSetPropData -glade_command_set_property -glade_command_set_properties -glade_command_set_properties_list -glade_command_cut -glade_command_copy -glade_command_paste -glade_command_add_signal -glade_command_remove_signal -glade_command_change_signal +<FILE>glade-design-layout</FILE> +GladeDesignLayoutPrivate +<TITLE>GladeDesignLayout</TITLE> +GladeDesignLayout +glade_design_layout_new +glade_design_layout_widget_event <SUBSECTION Standard> -GLADE_COMMAND -GLADE_IS_COMMAND -GLADE_TYPE_COMMAND -glade_command_get_type -GLADE_COMMAND_CLASS -GLADE_IS_COMMAND_CLASS -GLADE_COMMAND_GET_CLASS -GladeCommandClass -GladeCommand +GLADE_DESIGN_LAYOUT +GLADE_IS_DESIGN_LAYOUT +GLADE_TYPE_DESIGN_LAYOUT +glade_design_layout_get_type +GLADE_DESIGN_LAYOUT_CLASS +GLADE_IS_DESIGN_LAYOUT_CLASS +GLADE_DESIGN_LAYOUT_GET_CLASS +</SECTION> + +<SECTION> +<FILE>glade-signal</FILE> +GladeSignal +glade_signal_new +glade_signal_clone +glade_signal_free +glade_signal_equal +glade_signal_write +glade_signal_new_from_signal_info +<SUBSECTION Standard> +GLADE_SIGNAL +GLADE_IS_SIGNAL </SECTION> <SECTION> @@ -135,12 +261,12 @@ GladeCommand <TITLE>GladeEditorProperty</TITLE> GladeEditorProperty glade_editor_property_new +glade_editor_property_new_from_widget glade_editor_property_load glade_editor_property_load_by_widget glade_editor_property_supported -glade_editor_property_new_from_widget -glade_editor_property_hide_info glade_editor_property_show_info +glade_editor_property_hide_info <SUBSECTION Standard> GLADE_EDITOR_PROPERTY GLADE_IS_EDITOR_PROPERTY @@ -149,66 +275,78 @@ glade_editor_property_get_type GLADE_EDITOR_PROPERTY_CLASS GLADE_IS_EDITOR_PROPERTY_CLASS GLADE_EDITOR_PROPERTY_GET_CLASS -GladeEditorPropertyClass </SECTION> <SECTION> -<FILE>glade-editor</FILE> -<TITLE>GladeEditor</TITLE> -GladeEditor -glade_editor_new -glade_editor_load_widget -glade_editor_refresh -glade_editor_update_widget_name -glade_editor_query_dialog -glade_editor_show_info -glade_editor_hide_info -glade_editor_show_context_info -glade_editor_hide_context_info +<FILE>glade-widget-action</FILE> +<TITLE>GWAction</TITLE> +<TITLE>GladeWidgetAction</TITLE> +GladeWidgetAction +glade_widget_action_class_free +glade_widget_action_class_clone +glade_widget_action_remove +glade_widget_action_set_sensitive <SUBSECTION Standard> -GLADE_EDITOR -GLADE_IS_EDITOR -GLADE_TYPE_EDITOR -glade_editor_get_type -GLADE_EDITOR_CLASS -GLADE_IS_EDITOR_CLASS -GLADE_EDITOR_GET_CLASS -<SUBSECTION Private> -GLADE_EDITOR_TABLE -GLADE_IS_EDITOR_TABLE -GladeEditorTable +GLADE_WIDGET_ACTION +GLADE_IS_WIDGET_ACTION +GLADE_TYPE_WIDGET_ACTION +glade_widget_action_get_type +GLADE_WIDGET_ACTION_CLASS +GLADE_IS_WIDGET_ACTION_CLASS +GLADE_WIDGET_ACTION_GET_CLASS </SECTION> <SECTION> <FILE>glade-fixed</FILE> -<TITLE>GladeFixed</TITLE> -GladeFixed +GLADE_FIXED_CURSOR_TOP GLADE_FIXED_CURSOR_BOTTOM GLADE_FIXED_CURSOR_RIGHT -GLADE_FIXED_CURSOR_TOP GLADE_FIXED_CURSOR_LEFT +<TITLE>GladeFixed</TITLE> +GladeFixed <SUBSECTION Standard> -glade_fixed_get_type -GLADE_TYPE_FIXED -GLADE_FIXED_GET_CLASS +GLADE_FIXED GLADE_IS_FIXED -GLADE_IS_FIXED_CLASS +GLADE_TYPE_FIXED +glade_fixed_get_type GLADE_FIXED_CLASS -GLADE_FIXED -GladeFixedClass +GLADE_IS_FIXED_CLASS +GLADE_FIXED_GET_CLASS +</SECTION> + +<SECTION> +<FILE>glade-clipboard-view</FILE> +<TITLE>GladeClipboardView</TITLE> +GladeClipboardView +glade_clipboard_view_new +glade_clipboard_view_add +glade_clipboard_view_remove +glade_clipboard_view_refresh_sel +<SUBSECTION Standard> +GLADE_CLIPBOARD_VIEW +GLADE_IS_CLIPBOARD_VIEW +GLADE_TYPE_CLIPBOARD_VIEW +glade_clipboard_view_get_type +GLADE_CLIPBOARD_VIEW_CLASS +GLADE_IS_CLIPBOARD_VIEW_CLASS +GLADE_CLIPBOARD_VIEW_GET_CLASS </SECTION> <SECTION> <FILE>glade-palette</FILE> +GladePalettePrivate <TITLE>GladePalette</TITLE> GladePalette +GladeItemAppearance glade_palette_new +glade_palette_deselect_current_item +glade_palette_get_current_item glade_palette_get_item_appearance glade_palette_set_item_appearance -glade_palette_get_current_item_class -glade_palette_deselect_current_item glade_palette_get_use_small_item_icons glade_palette_set_use_small_item_icons +glade_palette_set_show_selector_button +glade_palette_get_show_selector_button <SUBSECTION Standard> GLADE_PALETTE GLADE_IS_PALETTE @@ -217,9 +355,6 @@ glade_palette_get_type GLADE_PALETTE_CLASS GLADE_IS_PALETTE_CLASS GLADE_PALETTE_GET_CLASS -GladePaletteClass -<SUBSECTION Private> -GladePalettePrivate </SECTION> <SECTION> @@ -236,45 +371,29 @@ glade_placeholder_get_type GLADE_PLACEHOLDER_CLASS GLADE_IS_PLACEHOLDER_CLASS GLADE_PLACEHOLDER_GET_CLASS -GladePlaceholderClass -<SUBSECTION Private> -GLADE_PLACEHOLDER_WIDTH_REQ -GLADE_PLACEHOLDER_HEIGHT_REQ -</SECTION> - -<SECTION> -<FILE>glade-inspector</FILE> -<TITLE>GladeInspector</TITLE> -GladeInspector -glade_inspector_new -glade_inspector_new_with_project -glade_inspector_get_project -glade_inspector_set_project -glade_inspector_get_selected_items -<SUBSECTION Standard> -GLADE_INSPECTOR -GLADE_IS_INSPECTOR -GLADE_TYPE_INSPECTOR -GLADE_INSPECTOR_CLASS -GLADE_IS_INSPECTOR_CLASS -GLADE_INSPECTOR_GET_CLASS -glade_inspector_get_type -GladeInspectorClass </SECTION> <SECTION> <FILE>glade-project</FILE> +GladeProjectPrivate <TITLE>GladeProject</TITLE> GladeProject glade_project_new -glade_project_open +glade_project_load_from_file +glade_project_load glade_project_save -glade_project_push_undo -glade_project_redo +glade_project_get_path +glade_project_get_name glade_project_undo -glade_project_next_redo_item +glade_project_redo glade_project_next_undo_item +glade_project_next_redo_item +glade_project_push_undo +glade_project_undo_items +glade_project_redo_items glade_project_reset_path +glade_project_get_readonly +glade_project_get_objects glade_project_add_object glade_project_remove_object glade_project_has_object @@ -289,14 +408,16 @@ glade_project_selection_remove glade_project_selection_clear glade_project_selection_changed glade_project_selection_get +glade_project_get_has_selection glade_project_set_accel_group glade_project_set_resource glade_project_list_resources glade_project_resource_fullpath -glade_project_display_name glade_project_is_loading -glade_project_get_has_selection -glade_project_get_readonly +glade_project_get_file_mtime +glade_project_get_instance_count +glade_project_set_instance_count +glade_project_get_modified <SUBSECTION Standard> GLADE_PROJECT GLADE_IS_PROJECT @@ -305,52 +426,165 @@ glade_project_get_type GLADE_PROJECT_CLASS GLADE_IS_PROJECT_CLASS GLADE_PROJECT_GET_CLASS -GladeProjectClass </SECTION> <SECTION> -<FILE>glade-property-class</FILE> -<TITLE>GladePropertyClass</TITLE> -GladePropertyClass -GPCType -GladeVerifyPropertyFunc -GladeGetPropertyFunc -GladeSetPropertyFunc -glade_property_class_new -glade_property_class_new_from_spec -glade_property_class_clone -glade_property_class_free -glade_property_class_is_visible -glade_property_class_is_object -glade_property_class_make_gvalue_from_string -glade_property_class_make_string_from_gvalue -glade_property_class_make_gvalue_from_vl -glade_property_class_set_vl_from_gvalue -glade_property_class_get_from_gvalue -glade_property_class_make_gvalue -glade_property_class_update_from_node -glade_property_class_get_displayable_value -glade_property_class_make_adjustment -glade_property_class_match -glade_property_class_void_value -glade_property_class_atk_realname -glade_property_class_list_atk_relations -glade_property_class_accel_property -<SUBSECTION Private> -GPC_PROPERTY_NAMELEN +<FILE>glade-base-editor</FILE> +GladeBaseEditorPrivate +<TITLE>GladeBaseEditor</TITLE> +GladeBaseEditor +glade_base_editor_new +glade_base_editor_add_default_properties +glade_base_editor_add_properties +glade_base_editor_add_label +glade_base_editor_add_popup_items +glade_base_editor_set_show_signal_editor +glade_base_editor_pack_new_window <SUBSECTION Standard> -GLADE_PROPERTY_CLASS -GLADE_IS_PROPERTY_CLASS +GLADE_BASE_EDITOR +GLADE_IS_BASE_EDITOR +GLADE_TYPE_BASE_EDITOR +glade_base_editor_get_type +GLADE_BASE_EDITOR_CLASS +GLADE_IS_BASE_EDITOR_CLASS +GLADE_BASE_EDITOR_GET_CLASS +</SECTION> + +<SECTION> +<FILE>glade-inspector</FILE> +GladeInspectorPrivate +<TITLE>GladeInspector</TITLE> +GladeInspector +glade_inspector_new +glade_inspector_new_with_project +glade_inspector_set_project +glade_inspector_get_project +glade_inspector_get_selected_items +<SUBSECTION Standard> +GLADE_INSPECTOR +GLADE_IS_INSPECTOR +GLADE_TYPE_INSPECTOR +glade_inspector_get_type +GLADE_INSPECTOR_CLASS +GLADE_IS_INSPECTOR_CLASS +GLADE_INSPECTOR_GET_CLASS +</SECTION> + +<SECTION> +<FILE>glade-signal-editor</FILE> +GladeSignalEditor +glade_signal_editor_get_widget +glade_signal_editor_new +glade_signal_editor_load_widget +<SUBSECTION Standard> +GLADE_SIGNAL_EDITOR +GLADE_IS_SIGNAL_EDITOR +</SECTION> + +<SECTION> +<FILE>glade-editor</FILE> +GLADE_EDITOR_TABLE +GLADE_IS_EDITOR_TABLE +GladeEditorTable +GladeEditorTableType +<TITLE>GladeEditor</TITLE> +GladeEditor +glade_editor_new +glade_editor_load_widget +glade_editor_refresh +glade_editor_update_widget_name +glade_editor_query_dialog +glade_editor_show_info +glade_editor_show_context_info +glade_editor_hide_info +glade_editor_hide_context_info +<SUBSECTION Standard> +GLADE_EDITOR +GLADE_IS_EDITOR +GLADE_TYPE_EDITOR +glade_editor_get_type +GLADE_EDITOR_CLASS +GLADE_IS_EDITOR_CLASS +GLADE_EDITOR_GET_CLASS +</SECTION> + +<SECTION> +<FILE>glade-app</FILE> +GLADE_TYPE_POINTER_MODE +GladeAppPrivate +<TITLE>GladeApp</TITLE> +GladeApp +glade_app_new +glade_pointer_mode_get_type +glade_app_get +glade_app_update_ui +glade_app_set_window +glade_app_get_window +glade_app_get_editor +glade_app_get_palette +glade_app_get_clipboard +glade_app_get_clipboard_view +glade_app_get_project +glade_app_set_project +glade_app_get_pointer_mode +glade_app_set_pointer_mode +glade_app_add_project +glade_app_remove_project +glade_app_get_projects +glade_app_get_config +glade_app_is_project_loaded +glade_app_get_project_by_path +glade_app_show_properties +glade_app_hide_properties +glade_app_command_copy +glade_app_command_cut +glade_app_command_paste +glade_app_command_delete +glade_app_command_delete_clipboard +glade_app_command_undo +glade_app_command_redo +glade_app_config_save +glade_app_set_transient_parent +glade_app_get_transient_parent +glade_app_set_accel_group +glade_app_update_instance_count +glade_app_undo_button_new +glade_app_redo_button_new +glade_app_get_selection +glade_app_is_selected +glade_app_selection_set +glade_app_selection_add +glade_app_selection_remove +glade_app_selection_clear +glade_app_selection_changed +glade_app_get_catalogs_dir +glade_app_get_modules_dir +glade_app_get_plugins_dir +glade_app_get_pixmaps_dir +glade_app_get_locale_dir +<SUBSECTION Standard> +GLADE_APP +GLADE_IS_APP +GLADE_TYPE_APP +glade_app_get_type +GLADE_APP_CLASS +GLADE_IS_APP_CLASS +GLADE_APP_GET_CLASS </SECTION> <SECTION> <FILE>glade-property</FILE> -<TITLE>GladeProperty</TITLE> +GLADE_PROPERTY_KLASS +GLADE_IS_PROPERTY_KLASS +GLADE_PROPERTY_GET_KLASS +GladePropertyKlass GladeProperty glade_property_new glade_property_dup glade_property_reset +glade_property_original_reset glade_property_default +glade_property_original_default glade_property_equals_value glade_property_equals glade_property_set_value @@ -366,12 +600,11 @@ glade_property_sync glade_property_load glade_property_read glade_property_write -glade_property_superuser -glade_property_push_superuser -glade_property_pop_superuser glade_property_get_tooltip glade_property_set_sensitive glade_property_get_sensitive +glade_property_set_save_always +glade_property_get_save_always glade_property_set_enabled glade_property_get_enabled glade_property_i18n_set_comment @@ -380,155 +613,50 @@ glade_property_i18n_set_translatable glade_property_i18n_get_translatable glade_property_i18n_set_has_context glade_property_i18n_get_has_context +glade_property_push_superuser +glade_property_pop_superuser +glade_property_superuser <SUBSECTION Standard> -GLADE_PROPERTY_KLASS -GLADE_IS_PROPERTY_KLASS -GLADE_PROPERTY_GET_KLASS GLADE_PROPERTY GLADE_IS_PROPERTY GLADE_TYPE_PROPERTY glade_property_get_type -GladePropertyKlass -</SECTION> - -<SECTION> -<FILE>glade-signal-editor</FILE> -GladeSignalEditor -glade_signal_editor_get_widget -glade_signal_editor_new -glade_signal_editor_load_widget -<SUBSECTION Standard> -GLADE_SIGNAL_EDITOR -GLADE_IS_SIGNAL_EDITOR -GladeEditorClass -</SECTION> - -<SECTION> -<FILE>glade-signal</FILE> -GladeSignal -glade_signal_new -glade_signal_clone -glade_signal_free -glade_signal_equal -glade_signal_write -glade_signal_new_from_signal_info -<SUBSECTION Standard> -GLADE_SIGNAL -GLADE_IS_SIGNAL -</SECTION> - -<SECTION> -<FILE>glade-widget-class</FILE> -<TITLE>GladeWidgetClass</TITLE> -GladeWidgetClass -GladeSignalClass -GladeCreateReason -GladePostCreateFunc -GladeChildSetPropertyFunc -GladeChildGetPropertyFunc -GladeGetChildrenFunc -GladeAddChildFunc -GladeRemoveChildFunc -GladeReplaceChildFunc -GladeGetInternalFunc -GladeEditorLaunchFunc -glade_widget_class_new -glade_widget_class_free -glade_widget_class_get_by_name -glade_widget_class_get_by_type -glade_widget_class_from_pclass -glade_widget_class_create_widget -glade_widget_class_create_internal -glade_widget_class_default_params -glade_widget_class_query -glade_widget_class_get_derived_types -glade_widget_class_dump_param_specs -glade_widget_class_get_property_class -glade_widget_class_get_child_support -glade_widget_class_container_add -glade_widget_class_container_remove -glade_widget_class_container_has_child -glade_widget_class_container_get_children -glade_widget_class_container_set_property -glade_widget_class_container_get_property -glade_widget_class_container_replace_child -glade_widget_class_contains_extra -glade_widget_class_get_packing_default -<SUBSECTION Standard> -glade_widget_class_get_type -GLADE_WIDGET_CLASS -GLADE_IS_WIDGET_CLASS -<SUBSECTION Private> -glade_widget_class_create_widget_real -GPC_OBJECT_DELIMITER -GLADE_VALID_CREATE_REASON -GladeSupportedChild </SECTION> <SECTION> -<FILE>glade-widget</FILE> -<TITLE>GladeWidget</TITLE> -GladeWidget -glade_widget_get_from_gobject -glade_widget_add_child -glade_widget_remove_child -glade_widget_set_name -glade_widget_set_internal -glade_widget_set_object -glade_widget_set_project -glade_widget_get_name -glade_widget_get_internal -glade_widget_get_class -glade_widget_get_project -glade_widget_get_object -glade_widget_project_notify -glade_widget_show -glade_widget_hide -glade_widget_copy_properties -glade_widget_set_packing_properties -glade_widget_add_prop_ref -glade_widget_remove_prop_ref -glade_widget_get_property -glade_widget_get_pack_property -glade_widget_property_get -glade_widget_property_set -glade_widget_pack_property_get -glade_widget_pack_property_set -glade_widget_property_reset -glade_widget_pack_property_reset -glade_widget_property_default -glade_widget_pack_property_default -glade_widget_property_set_sensitive -glade_widget_pack_property_set_sensitive -glade_widget_property_set_enabled -glade_widget_pack_property_set_enabled -glade_widget_has_decendant -glade_widget_replace -glade_widget_rebuild -glade_widget_dup -glade_widget_add_signal_handler -glade_widget_remove_signal_handler -glade_widget_change_signal_handler -glade_widget_list_signal_handlers -glade_widget_write -glade_widget_read -glade_widget_has_launcher -glade_widget_launch_editor -glade_widget_get_parent -glade_widget_set_parent -glade_widget_event_widget -glade_widget_superuser -glade_widget_push_superuser -glade_widget_pop_superuser +<FILE>glade-command</FILE> +GCSetPropData +<TITLE>GladeCommand</TITLE> +GladeCommand +glade_command_push_group +glade_command_pop_group +glade_command_execute +glade_command_undo +glade_command_unifies +glade_command_collapse +glade_command_set_property +glade_command_set_property_value +glade_command_set_properties +glade_command_set_properties_list +glade_command_set_name +glade_command_delete +glade_command_create +glade_command_cut +glade_command_copy +glade_command_paste +glade_command_dnd +glade_command_add_signal +glade_command_remove_signal +glade_command_change_signal +glade_command_set_i18n <SUBSECTION Standard> -GLADE_WIDGET -GLADE_IS_WIDGET -GLADE_TYPE_WIDGET -glade_widget_get_type -GLADE_WIDGET_KLASS -GLADE_IS_WIDGET_KLASS -GLADE_WIDGET_GET_KLASS -GladeWidgetKlass +GLADE_COMMAND +GLADE_IS_COMMAND +GLADE_TYPE_COMMAND +glade_command_get_type +GLADE_COMMAND_CLASS +GLADE_IS_COMMAND_CLASS +GLADE_COMMAND_GET_CLASS </SECTION> <SECTION> @@ -556,45 +684,21 @@ GladeChildInfo GladeInterface GladeAtkRelationInfo GladePackingDefault -glade_interface_new -glade_parser_parse_file -glade_parser_parse_buffer -glade_interface_destroy -glade_interface_dump -glade_interface_dump_full -<SUBSECTION Private> +glade_parser_interface_new +glade_parser_interface_new_from_file +glade_parser_interface_new_from_buffer +glade_parser_interface_destroy +glade_parser_interface_dump glade_parser_pvalue_from_winfo </SECTION> <SECTION> -<FILE>glade-base-editor</FILE> -GladeBaseEditor -glade_base_editor_new -glade_base_editor_add_popup_items -glade_base_editor_pack_new_window -glade_base_editor_add_properties -glade_base_editor_add_label -glade_base_editor_add_default_properties -glade_base_editor_set_show_signal_editor -<SUBSECTION Standard> -glade_base_editor_get_type -GladeBaseEditorClass -GLADE_TYPE_BASE_EDITOR -GLADE_IS_BASE_EDITOR_CLASS -GLADE_BASE_EDITOR_GET_CLASS -GLADE_BASE_EDITOR_CLASS -GLADE_IS_BASE_EDITOR -GLADE_BASE_EDITOR -<SUBSECTION Private> -GladeBaseEditorPrivate -</SECTION> - -<SECTION> <FILE>glade-utils</FILE> +GladeUtilFileDialogType +GladeUIMessageType glade_util_widget_set_tooltip glade_util_get_type_from_name glade_utils_get_pspec_from_funcname -GladeUIMessageType glade_util_ui_message glade_util_flash_message glade_util_compare_stock_labels @@ -610,28 +714,25 @@ glade_util_remove_selection glade_util_has_selection glade_util_clear_selection glade_util_get_selection -glade_util_selected_placeholder glade_util_queue_draw_nodes -glade_util_get_parent glade_util_container_get_all_children -glade_util_uri_list_parse -glade_util_gtkcontainer_relation -glade_util_any_gtkcontainer_relation -glade_util_widget_pastable glade_util_count_placeholders glade_util_find_iter_by_widget glade_util_basenames_match glade_util_purify_list -glade_util_removed_from_list glade_util_added_in_list +glade_util_removed_from_list glade_util_canonical_path glade_util_copy_file -glade_util_file_is_writeable -glade_util_load_library glade_util_class_implements_interface +glade_util_load_library +glade_util_file_is_writeable glade_util_have_devhelp +glade_util_get_devhelp_icon glade_util_search_devhelp -glade_util_deep_fixed_event +glade_util_get_placeholder_from_pointer +glade_util_object_is_loading +glade_util_url_show +glade_util_get_file_mtime </SECTION> - diff --git a/doc/gladeui.types b/doc/gladeui.types index 44967dfd..a62e4355 100644 --- a/doc/gladeui.types +++ b/doc/gladeui.types @@ -13,3 +13,4 @@ glade_project_get_type glade_inspector_get_type glade_property_get_type glade_widget_get_type +glade_widget_adaptor_get_type diff --git a/doc/tmpl/glade-app.sgml b/doc/tmpl/glade-app.sgml index 8b27f728..229c0c3c 100644 --- a/doc/tmpl/glade-app.sgml +++ b/doc/tmpl/glade-app.sgml @@ -2,14 +2,11 @@ GladeApp <!-- ##### SECTION Short_Description ##### --> -The central control point of the Glade core + <!-- ##### SECTION Long_Description ##### --> <para> -This main control object is where we try to draw the line between -what is the Glade core and what is the main application. The main -application must derive from the GladeApp object and create an instance -to initialize the Glade core. + </para> <!-- ##### SECTION See_Also ##### --> @@ -20,6 +17,19 @@ to initialize the Glade core. <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### MACRO GLADE_TYPE_POINTER_MODE ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT GladeAppPrivate ##### --> +<para> + +</para> + + <!-- ##### STRUCT GladeApp ##### --> <para> @@ -43,6 +53,22 @@ to initialize the Glade core. </para> +<!-- ##### FUNCTION glade_app_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION glade_pointer_mode_get_type ##### --> +<para> + +</para> + +@Returns: + + <!-- ##### FUNCTION glade_app_get ##### --> <para> @@ -106,6 +132,14 @@ to initialize the Glade core. @Returns: +<!-- ##### FUNCTION glade_app_get_project ##### --> +<para> + +</para> + +@Returns: + + <!-- ##### FUNCTION glade_app_set_project ##### --> <para> @@ -114,7 +148,7 @@ to initialize the Glade core. @project: -<!-- ##### FUNCTION glade_app_get_project ##### --> +<!-- ##### FUNCTION glade_app_get_pointer_mode ##### --> <para> </para> @@ -122,6 +156,14 @@ to initialize the Glade core. @Returns: +<!-- ##### FUNCTION glade_app_set_pointer_mode ##### --> +<para> + +</para> + +@mode: + + <!-- ##### FUNCTION glade_app_add_project ##### --> <para> @@ -138,16 +180,15 @@ to initialize the Glade core. @project: -<!-- ##### FUNCTION glade_app_get_project_by_path ##### --> +<!-- ##### FUNCTION glade_app_get_projects ##### --> <para> </para> -@project_path: @Returns: -<!-- ##### FUNCTION glade_app_get_projects ##### --> +<!-- ##### FUNCTION glade_app_get_config ##### --> <para> </para> @@ -155,15 +196,16 @@ to initialize the Glade core. @Returns: -<!-- ##### FUNCTION glade_app_get_config ##### --> +<!-- ##### FUNCTION glade_app_is_project_loaded ##### --> <para> </para> +@project_path: @Returns: -<!-- ##### FUNCTION glade_app_is_project_loaded ##### --> +<!-- ##### FUNCTION glade_app_get_project_by_path ##### --> <para> </para> @@ -187,50 +229,50 @@ to initialize the Glade core. -<!-- ##### FUNCTION glade_app_command_undo ##### --> +<!-- ##### FUNCTION glade_app_command_copy ##### --> <para> </para> -<!-- ##### FUNCTION glade_app_command_redo ##### --> +<!-- ##### FUNCTION glade_app_command_cut ##### --> <para> </para> -<!-- ##### FUNCTION glade_app_command_copy ##### --> +<!-- ##### FUNCTION glade_app_command_paste ##### --> <para> </para> +@placeholder: -<!-- ##### FUNCTION glade_app_command_cut ##### --> +<!-- ##### FUNCTION glade_app_command_delete ##### --> <para> </para> -<!-- ##### FUNCTION glade_app_command_paste ##### --> +<!-- ##### FUNCTION glade_app_command_delete_clipboard ##### --> <para> </para> -@placeholder: -<!-- ##### FUNCTION glade_app_command_delete ##### --> +<!-- ##### FUNCTION glade_app_command_undo ##### --> <para> </para> -<!-- ##### FUNCTION glade_app_command_delete_clipboard ##### --> +<!-- ##### FUNCTION glade_app_command_redo ##### --> <para> </para> @@ -293,6 +335,32 @@ to initialize the Glade core. @Returns: +<!-- ##### FUNCTION glade_app_get_selection ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION glade_app_is_selected ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION glade_app_selection_set ##### --> +<para> + +</para> + +@object: +@emit_signal: + + <!-- ##### FUNCTION glade_app_selection_add ##### --> <para> @@ -311,6 +379,14 @@ to initialize the Glade core. @emit_signal: +<!-- ##### FUNCTION glade_app_selection_clear ##### --> +<para> + +</para> + +@emit_signal: + + <!-- ##### FUNCTION glade_app_selection_changed ##### --> <para> @@ -318,7 +394,7 @@ to initialize the Glade core. -<!-- ##### FUNCTION glade_app_get_selection ##### --> +<!-- ##### FUNCTION glade_app_get_catalogs_dir ##### --> <para> </para> @@ -326,29 +402,35 @@ to initialize the Glade core. @Returns: -<!-- ##### FUNCTION glade_app_selection_clear ##### --> +<!-- ##### FUNCTION glade_app_get_modules_dir ##### --> <para> </para> -@emit_signal: +@Returns: -<!-- ##### FUNCTION glade_app_selection_set ##### --> +<!-- ##### FUNCTION glade_app_get_plugins_dir ##### --> <para> </para> -@object: -@emit_signal: +@Returns: -<!-- ##### FUNCTION glade_app_is_selected ##### --> +<!-- ##### FUNCTION glade_app_get_pixmaps_dir ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION glade_app_get_locale_dir ##### --> <para> </para> -@object: @Returns: diff --git a/doc/tmpl/glade-base-editor.sgml b/doc/tmpl/glade-base-editor.sgml index 5439a289..014f429b 100644 --- a/doc/tmpl/glade-base-editor.sgml +++ b/doc/tmpl/glade-base-editor.sgml @@ -1,5 +1,5 @@ <!-- ##### SECTION Title ##### --> -glade-base-editor +GladeBaseEditor <!-- ##### SECTION Short_Description ##### --> @@ -17,6 +17,12 @@ glade-base-editor <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### STRUCT GladeBaseEditorPrivate ##### --> +<para> + +</para> + + <!-- ##### STRUCT GladeBaseEditor ##### --> <para> @@ -36,24 +42,13 @@ glade-base-editor @Returns: -<!-- ##### FUNCTION glade_base_editor_add_popup_items ##### --> -<para> - -</para> - -@editor: -@Varargs: - - -<!-- ##### FUNCTION glade_base_editor_pack_new_window ##### --> +<!-- ##### FUNCTION glade_base_editor_add_default_properties ##### --> <para> </para> @editor: -@title: -@markup: -@Returns: +@gchild: <!-- ##### FUNCTION glade_base_editor_add_properties ##### --> @@ -75,13 +70,13 @@ glade-base-editor @str: -<!-- ##### FUNCTION glade_base_editor_add_default_properties ##### --> +<!-- ##### FUNCTION glade_base_editor_add_popup_items ##### --> <para> </para> @editor: -@gchild: +@Varargs: <!-- ##### FUNCTION glade_base_editor_set_show_signal_editor ##### --> @@ -93,3 +88,14 @@ glade-base-editor @val: +<!-- ##### FUNCTION glade_base_editor_pack_new_window ##### --> +<para> + +</para> + +@editor: +@title: +@help_markup: +@Returns: + + diff --git a/doc/tmpl/glade-clipboard-view.sgml b/doc/tmpl/glade-clipboard-view.sgml index 8449a173..9148d38c 100644 --- a/doc/tmpl/glade-clipboard-view.sgml +++ b/doc/tmpl/glade-clipboard-view.sgml @@ -2,13 +2,11 @@ GladeClipboardView <!-- ##### SECTION Short_Description ##### --> -A widget to view and control the #GladeClipboard + <!-- ##### SECTION Long_Description ##### --> <para> -The #GladeClipboardView is a widget to view the #GladeWidget objects -in the #GladeClipboard; the user can paste or delete objects on the -clipboard. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/doc/tmpl/glade-clipboard.sgml b/doc/tmpl/glade-clipboard.sgml index e2774168..b73759a7 100644 --- a/doc/tmpl/glade-clipboard.sgml +++ b/doc/tmpl/glade-clipboard.sgml @@ -2,13 +2,11 @@ GladeClipboard <!-- ##### SECTION Short_Description ##### --> -A list of #GladeWidget objects not in any #GladeProject + <!-- ##### SECTION Long_Description ##### --> <para> -The #GladeClipboard is a singleton and is an accumulative shelf -of all cut or copied #GladeWidget in the application. A #GladeWidget -can be cut from one #GladeProject and pasted to another. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/doc/tmpl/glade-command.sgml b/doc/tmpl/glade-command.sgml index 84f1c4a0..1548ee64 100644 --- a/doc/tmpl/glade-command.sgml +++ b/doc/tmpl/glade-command.sgml @@ -1,13 +1,12 @@ <!-- ##### SECTION Title ##### --> -Glade Commands +GladeCommand <!-- ##### SECTION Short_Description ##### --> -An event filter to implement the Undo/Redo stack + <!-- ##### SECTION Long_Description ##### --> <para> -The Glade Command api allows us to view user actions as items and execute -and undo those items; each #GladeProject has its own Undo/Redo stack. + </para> <!-- ##### SECTION See_Also ##### --> @@ -18,6 +17,37 @@ and undo those items; each #GladeProject has its own Undo/Redo stack. <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### STRUCT GCSetPropData ##### --> +<para> + +</para> + +@property: +@new_value: +@old_value: + +<!-- ##### STRUCT GladeCommand ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION glade_command_push_group ##### --> +<para> + +</para> + +@fmt: +@Varargs: + + +<!-- ##### FUNCTION glade_command_pop_group ##### --> +<para> + +</para> + + + <!-- ##### FUNCTION glade_command_execute ##### --> <para> @@ -55,92 +85,82 @@ and undo those items; each #GladeProject has its own Undo/Redo stack. @other: -<!-- ##### FUNCTION glade_command_push_group ##### --> +<!-- ##### FUNCTION glade_command_set_property ##### --> <para> </para> -@fmt: +@property: @Varargs: -<!-- ##### FUNCTION glade_command_pop_group ##### --> +<!-- ##### FUNCTION glade_command_set_property_value ##### --> <para> </para> +@property: +@value: -<!-- ##### FUNCTION glade_command_set_name ##### --> +<!-- ##### FUNCTION glade_command_set_properties ##### --> <para> </para> -@glade_widget: -@name: +@property: +@old_value: +@new_value: +@Varargs: -<!-- ##### FUNCTION glade_command_create ##### --> +<!-- ##### FUNCTION glade_command_set_properties_list ##### --> <para> </para> -@adaptor: -@parent: -@placeholder: @project: -@Returns: +@props: -<!-- ##### FUNCTION glade_command_delete ##### --> +<!-- ##### FUNCTION glade_command_set_name ##### --> <para> </para> -@widgets: - - -<!-- ##### STRUCT GCSetPropData ##### --> -<para> -#GladeProperties can be set in a list as one command, -for Undo purposes; we store the list of #GCSetPropData with -their old and new #GValue. -</para> +@glade_widget: +@name: -@property: A #GladeProperty to set -@new_value: The new #GValue to assign to @property -@old_value: The old #GValue of @property -<!-- ##### FUNCTION glade_command_set_property ##### --> +<!-- ##### FUNCTION glade_command_delete ##### --> <para> </para> -@property: -@Varargs: +@widgets: -<!-- ##### FUNCTION glade_command_set_properties ##### --> +<!-- ##### FUNCTION glade_command_create ##### --> <para> </para> -@property: -@old_value: -@new_value: -@Varargs: +@adaptor: +@parent: +@placeholder: +@project: +@Returns: -<!-- ##### FUNCTION glade_command_set_properties_list ##### --> +<!-- ##### FUNCTION glade_command_cut ##### --> <para> </para> -@project: -@props: +@widgets: -<!-- ##### FUNCTION glade_command_cut ##### --> +<!-- ##### FUNCTION glade_command_copy ##### --> <para> </para> @@ -148,15 +168,17 @@ their old and new #GValue. @widgets: -<!-- ##### FUNCTION glade_command_copy ##### --> +<!-- ##### FUNCTION glade_command_paste ##### --> <para> </para> @widgets: +@parent: +@placeholder: -<!-- ##### FUNCTION glade_command_paste ##### --> +<!-- ##### FUNCTION glade_command_dnd ##### --> <para> </para> @@ -190,7 +212,18 @@ their old and new #GValue. </para> @glade_widget: -@old: +@old_signal: @new_signal: +<!-- ##### FUNCTION glade_command_set_i18n ##### --> +<para> + +</para> + +@property: +@translatable: +@has_context: +@comment: + + diff --git a/doc/tmpl/glade-design-layout.sgml b/doc/tmpl/glade-design-layout.sgml new file mode 100644 index 00000000..b4c4665c --- /dev/null +++ b/doc/tmpl/glade-design-layout.sgml @@ -0,0 +1,52 @@ +<!-- ##### SECTION Title ##### --> +GladeDesignLayout + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT GladeDesignLayoutPrivate ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GladeDesignLayout ##### --> +<para> + +</para> + +@parent_instance: +@priv: + +<!-- ##### FUNCTION glade_design_layout_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION glade_design_layout_widget_event ##### --> +<para> + +</para> + +@layout: +@event_gwidget: +@event: +@Returns: + + diff --git a/doc/tmpl/glade-design-view.sgml b/doc/tmpl/glade-design-view.sgml new file mode 100644 index 00000000..aeb46fb1 --- /dev/null +++ b/doc/tmpl/glade-design-view.sgml @@ -0,0 +1,69 @@ +<!-- ##### SECTION Title ##### --> +GladeDesignView + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT GladeDesignViewPrivate ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GladeDesignView ##### --> +<para> + +</para> + +@parent_instance: +@priv: + +<!-- ##### FUNCTION glade_design_view_new ##### --> +<para> + +</para> + +@project: +@Returns: + + +<!-- ##### FUNCTION glade_design_view_get_project ##### --> +<para> + +</para> + +@view: +@Returns: + + +<!-- ##### FUNCTION glade_design_view_get_from_project ##### --> +<para> + +</para> + +@project: +@Returns: + + +<!-- ##### FUNCTION glade_design_view_get_layout ##### --> +<para> + +</para> + +@view: +@Returns: + + diff --git a/doc/tmpl/glade-editor-property.sgml b/doc/tmpl/glade-editor-property.sgml index 456202f0..b02b670f 100644 --- a/doc/tmpl/glade-editor-property.sgml +++ b/doc/tmpl/glade-editor-property.sgml @@ -2,13 +2,11 @@ GladeEditorProperty <!-- ##### SECTION Short_Description ##### --> -A generic widget to edit a #GladeProperty + <!-- ##### SECTION Long_Description ##### --> <para> -The #GladeEditorProperty is a factory that will create the correct -control for the #GladePropertyClass it was created for and provides -a simple unified api to them. + </para> <!-- ##### SECTION See_Also ##### --> @@ -60,45 +58,45 @@ a simple unified api to them. @Returns: -<!-- ##### FUNCTION glade_editor_property_load ##### --> +<!-- ##### FUNCTION glade_editor_property_new_from_widget ##### --> <para> </para> -@eprop: +@widget: @property: +@use_command: +@Returns: -<!-- ##### FUNCTION glade_editor_property_load_by_widget ##### --> +<!-- ##### FUNCTION glade_editor_property_load ##### --> <para> </para> @eprop: -@widget: +@property: -<!-- ##### FUNCTION glade_editor_property_supported ##### --> +<!-- ##### FUNCTION glade_editor_property_load_by_widget ##### --> <para> </para> -@pspec: -@Returns: +@eprop: +@widget: -<!-- ##### FUNCTION glade_editor_property_new_from_widget ##### --> +<!-- ##### FUNCTION glade_editor_property_supported ##### --> <para> </para> -@widget: -@property: -@use_command: +@pspec: @Returns: -<!-- ##### FUNCTION glade_editor_property_hide_info ##### --> +<!-- ##### FUNCTION glade_editor_property_show_info ##### --> <para> </para> @@ -106,7 +104,7 @@ a simple unified api to them. @eprop: -<!-- ##### FUNCTION glade_editor_property_show_info ##### --> +<!-- ##### FUNCTION glade_editor_property_hide_info ##### --> <para> </para> diff --git a/doc/tmpl/glade-editor.sgml b/doc/tmpl/glade-editor.sgml index b5dcbf6b..4ccef30a 100644 --- a/doc/tmpl/glade-editor.sgml +++ b/doc/tmpl/glade-editor.sgml @@ -2,12 +2,11 @@ GladeEditor <!-- ##### SECTION Short_Description ##### --> -A Widget to edit a #GladeWidget + <!-- ##### SECTION Long_Description ##### --> <para> -This is the Glade Notebook containing all the controls needed to -configure a #GladeWidget. + </para> <!-- ##### SECTION See_Also ##### --> @@ -18,6 +17,46 @@ configure a #GladeWidget. <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### MACRO GLADE_EDITOR_TABLE ##### --> +<para> + +</para> + +@t: + + +<!-- ##### MACRO GLADE_IS_EDITOR_TABLE ##### --> +<para> + +</para> + +@t: + + +<!-- ##### STRUCT GladeEditorTable ##### --> +<para> + +</para> + +@editor: +@adaptor: +@table_widget: +@name_entry: +@properties: +@type: +@rows: + +<!-- ##### ENUM GladeEditorTableType ##### --> +<para> + +</para> + +@TABLE_TYPE_GENERAL: +@TABLE_TYPE_COMMON: +@TABLE_TYPE_PACKING: +@TABLE_TYPE_ATK: +@TABLE_TYPE_QUERY: + <!-- ##### STRUCT GladeEditor ##### --> <para> @@ -95,7 +134,7 @@ configure a #GladeWidget. @editor: -<!-- ##### FUNCTION glade_editor_hide_info ##### --> +<!-- ##### FUNCTION glade_editor_show_context_info ##### --> <para> </para> @@ -103,7 +142,7 @@ configure a #GladeWidget. @editor: -<!-- ##### FUNCTION glade_editor_show_context_info ##### --> +<!-- ##### FUNCTION glade_editor_hide_info ##### --> <para> </para> diff --git a/doc/tmpl/glade-fixed.sgml b/doc/tmpl/glade-fixed.sgml index c312b5a1..2851ca8e 100644 --- a/doc/tmpl/glade-fixed.sgml +++ b/doc/tmpl/glade-fixed.sgml @@ -2,36 +2,51 @@ GladeFixed <!-- ##### SECTION Short_Description ##### --> -An object wrapper for free-form placement container widgets + <!-- ##### SECTION Long_Description ##### --> <para> -#GladeFixed is a specialized #GladeWidget to handle free-form child -placements in containers that support this, it is designed with properties -and signals with flexable integration in mind. + </para> +<!-- ##### SECTION See_Also ##### --> <para> -If you set the x-prop/y-prop/width-prop/height-prop properties and -leave the signals alone, #GladeFixed will assume you are like a -GtkFixed/GtkLayout widget and will use pixel counts as units for -these properties. + </para> +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO GLADE_FIXED_CURSOR_TOP ##### --> <para> -If you handle the configure-child/configure-end[/configure-begin] signals -and dont let them propagate to the GladeFixed, then the x-prop/y-prop/width-prop/height-prop -properties will be completely ignored and it is up to the implementor to play -with whatever child packing properties are available to make a closest match -for the values passed to configure-child via the #GdkRectangle. + </para> -<!-- ##### SECTION See_Also ##### --> +@type: + + +<!-- ##### MACRO GLADE_FIXED_CURSOR_BOTTOM ##### --> <para> </para> -<!-- ##### SECTION Stability_Level ##### --> +@type: + + +<!-- ##### MACRO GLADE_FIXED_CURSOR_RIGHT ##### --> +<para> + +</para> + +@type: + + +<!-- ##### MACRO GLADE_FIXED_CURSOR_LEFT ##### --> +<para> + +</para> + +@type: <!-- ##### STRUCT GladeFixed ##### --> @@ -93,35 +108,3 @@ for the values passed to configure-child via the #GdkRectangle. </para> -<!-- ##### MACRO GLADE_FIXED_CURSOR_BOTTOM ##### --> -<para> - -</para> - -@type: - - -<!-- ##### MACRO GLADE_FIXED_CURSOR_RIGHT ##### --> -<para> - -</para> - -@type: - - -<!-- ##### MACRO GLADE_FIXED_CURSOR_TOP ##### --> -<para> - -</para> - -@type: - - -<!-- ##### MACRO GLADE_FIXED_CURSOR_LEFT ##### --> -<para> - -</para> - -@type: - - diff --git a/doc/tmpl/glade-inspector.sgml b/doc/tmpl/glade-inspector.sgml index 25c6e723..df5d8409 100644 --- a/doc/tmpl/glade-inspector.sgml +++ b/doc/tmpl/glade-inspector.sgml @@ -2,16 +2,11 @@ GladeInspector <!-- ##### SECTION Short_Description ##### --> -A widget for inspecting objects in a #GladeProject + <!-- ##### SECTION Long_Description ##### --> <para> -A #GladeInspector is a widget for inspecting the objects that make up a user interface. -</para> -<para> -An inspector is created by calling either glade_inspector_new() or glade_inspector_new_with_project(). -The current project been inspected can be changed by calling glade_inspector_set_project(). </para> <!-- ##### SECTION See_Also ##### --> @@ -22,9 +17,15 @@ The current project been inspected can be changed by calling glade_inspector_set <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### STRUCT GladeInspectorPrivate ##### --> +<para> + +</para> + + <!-- ##### STRUCT GladeInspector ##### --> <para> -The #GladeInspector struct contains private data only, and should be manipulated using the functions below. + </para> @@ -64,22 +65,22 @@ The #GladeInspector struct contains private data only, and should be manipulated @Returns: -<!-- ##### FUNCTION glade_inspector_get_project ##### --> +<!-- ##### FUNCTION glade_inspector_set_project ##### --> <para> </para> @inspector: -@Returns: +@project: -<!-- ##### FUNCTION glade_inspector_set_project ##### --> +<!-- ##### FUNCTION glade_inspector_get_project ##### --> <para> </para> @inspector: -@project: +@Returns: <!-- ##### FUNCTION glade_inspector_get_selected_items ##### --> diff --git a/doc/tmpl/glade-palette.sgml b/doc/tmpl/glade-palette.sgml index a2e96cf0..d87be4bb 100644 --- a/doc/tmpl/glade-palette.sgml +++ b/doc/tmpl/glade-palette.sgml @@ -2,13 +2,11 @@ GladePalette <!-- ##### SECTION Short_Description ##### --> -A widget to select a #GladeWidgetClass for addition + <!-- ##### SECTION Long_Description ##### --> <para> -#GladePalette is responsible for displaying the list of available -#GladeWidgetClass types and publishing the currently selected class -to the Glade core. + </para> <!-- ##### SECTION See_Also ##### --> @@ -19,6 +17,12 @@ to the Glade core. <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### STRUCT GladePalettePrivate ##### --> +<para> + +</para> + + <!-- ##### STRUCT GladePalette ##### --> <para> @@ -57,6 +61,15 @@ to the Glade core. </para> +<!-- ##### ENUM GladeItemAppearance ##### --> +<para> + +</para> + +@GLADE_ITEM_ICON_AND_LABEL: +@GLADE_ITEM_ICON_ONLY: +@GLADE_ITEM_LABEL_ONLY: + <!-- ##### FUNCTION glade_palette_new ##### --> <para> @@ -66,7 +79,16 @@ to the Glade core. @Returns: -<!-- ##### FUNCTION glade_palette_get_item_appearance ##### --> +<!-- ##### FUNCTION glade_palette_deselect_current_item ##### --> +<para> + +</para> + +@palette: +@sticky_aware: + + +<!-- ##### FUNCTION glade_palette_get_current_item ##### --> <para> </para> @@ -75,22 +97,22 @@ to the Glade core. @Returns: -<!-- ##### FUNCTION glade_palette_set_item_appearance ##### --> +<!-- ##### FUNCTION glade_palette_get_item_appearance ##### --> <para> </para> @palette: -@appearance: +@Returns: -<!-- ##### FUNCTION glade_palette_deselect_current_item ##### --> +<!-- ##### FUNCTION glade_palette_set_item_appearance ##### --> <para> </para> @palette: -@sticky_aware: +@item_appearance: <!-- ##### FUNCTION glade_palette_get_use_small_item_icons ##### --> @@ -111,3 +133,21 @@ to the Glade core. @use_small_item_icons: +<!-- ##### FUNCTION glade_palette_set_show_selector_button ##### --> +<para> + +</para> + +@palette: +@show_selector_button: + + +<!-- ##### FUNCTION glade_palette_get_show_selector_button ##### --> +<para> + +</para> + +@palette: +@Returns: + + diff --git a/doc/tmpl/glade-parameter.sgml b/doc/tmpl/glade-parameter.sgml index 410af654..8d4ea6ce 100644 --- a/doc/tmpl/glade-parameter.sgml +++ b/doc/tmpl/glade-parameter.sgml @@ -1,13 +1,12 @@ <!-- ##### SECTION Title ##### --> -Catalog Parameters +glade-parameter <!-- ##### SECTION Short_Description ##### --> -Parameters set in the catalog retrievable from the plugin + <!-- ##### SECTION Long_Description ##### --> <para> -Parameters can be set in your catalog file that may determine how -your plugin will treat certain widget classes. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/doc/tmpl/glade-parser.sgml b/doc/tmpl/glade-parser.sgml index a3437b66..2d17337d 100644 --- a/doc/tmpl/glade-parser.sgml +++ b/doc/tmpl/glade-parser.sgml @@ -125,3 +125,61 @@ glade-parser @id: @value: +<!-- ##### FUNCTION glade_parser_interface_new ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION glade_parser_interface_new_from_file ##### --> +<para> + +</para> + +@file: +@domain: +@Returns: + + +<!-- ##### FUNCTION glade_parser_interface_new_from_buffer ##### --> +<para> + +</para> + +@buffer: +@len: +@domain: +@Returns: + + +<!-- ##### FUNCTION glade_parser_interface_destroy ##### --> +<para> + +</para> + +@interface: + + +<!-- ##### FUNCTION glade_parser_interface_dump ##### --> +<para> + +</para> + +@interface: +@filename: +@error: +@Returns: + + +<!-- ##### FUNCTION glade_parser_pvalue_from_winfo ##### --> +<para> + +</para> + +@winfo: +@pname: +@Returns: + + diff --git a/doc/tmpl/glade-placeholder.sgml b/doc/tmpl/glade-placeholder.sgml index 9487a8f4..eca25ec4 100644 --- a/doc/tmpl/glade-placeholder.sgml +++ b/doc/tmpl/glade-placeholder.sgml @@ -2,15 +2,11 @@ GladePlaceholder <!-- ##### SECTION Short_Description ##### --> -A #GtkWidget to fill empty places + <!-- ##### SECTION Long_Description ##### --> <para> -Generally in Glade, container widgets are implemented with #GladePlaceholder -children to allow users to 'click' and add thier widgets to a container. -It is the responsability of the plugin writer to create placeholders for -container widgets where appropriate; usually in #GladePostCreateFunc -when the #GladeCreateReason is %GLADE_CREATE_USER. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/doc/tmpl/glade-project.sgml b/doc/tmpl/glade-project.sgml index d0c7c459..f26c1fdd 100644 --- a/doc/tmpl/glade-project.sgml +++ b/doc/tmpl/glade-project.sgml @@ -2,13 +2,11 @@ GladeProject <!-- ##### SECTION Short_Description ##### --> -The Glade document hub and Load/Save interface + <!-- ##### SECTION Long_Description ##### --> <para> -This object owns all project objects and is responsable for loading and -saving the glade document, you can monitor the project state via this -object and its signals. + </para> <!-- ##### SECTION See_Also ##### --> @@ -19,6 +17,12 @@ object and its signals. <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### STRUCT GladeProjectPrivate ##### --> +<para> + +</para> + + <!-- ##### STRUCT GladeProject ##### --> <para> @@ -123,6 +127,25 @@ object and its signals. @Returns: +<!-- ##### FUNCTION glade_project_load_from_file ##### --> +<para> + +</para> + +@project: +@path: +@Returns: + + +<!-- ##### FUNCTION glade_project_load ##### --> +<para> + +</para> + +@path: +@Returns: + + <!-- ##### FUNCTION glade_project_save ##### --> <para> @@ -134,21 +157,22 @@ object and its signals. @Returns: -<!-- ##### FUNCTION glade_project_push_undo ##### --> +<!-- ##### FUNCTION glade_project_get_path ##### --> <para> </para> @project: -@cmd: +@Returns: -<!-- ##### FUNCTION glade_project_redo ##### --> +<!-- ##### FUNCTION glade_project_get_name ##### --> <para> </para> @project: +@Returns: <!-- ##### FUNCTION glade_project_undo ##### --> @@ -159,6 +183,23 @@ object and its signals. @project: +<!-- ##### FUNCTION glade_project_redo ##### --> +<para> + +</para> + +@project: + + +<!-- ##### FUNCTION glade_project_next_undo_item ##### --> +<para> + +</para> + +@project: +@Returns: + + <!-- ##### FUNCTION glade_project_next_redo_item ##### --> <para> @@ -168,7 +209,25 @@ object and its signals. @Returns: -<!-- ##### FUNCTION glade_project_next_undo_item ##### --> +<!-- ##### FUNCTION glade_project_push_undo ##### --> +<para> + +</para> + +@project: +@cmd: + + +<!-- ##### FUNCTION glade_project_undo_items ##### --> +<para> + +</para> + +@project: +@Returns: + + +<!-- ##### FUNCTION glade_project_redo_items ##### --> <para> </para> @@ -185,6 +244,24 @@ object and its signals. @project: +<!-- ##### FUNCTION glade_project_get_readonly ##### --> +<para> + +</para> + +@project: +@Returns: + + +<!-- ##### FUNCTION glade_project_get_objects ##### --> +<para> + +</para> + +@project: +@Returns: + + <!-- ##### FUNCTION glade_project_add_object ##### --> <para> @@ -319,6 +396,15 @@ object and its signals. @Returns: +<!-- ##### FUNCTION glade_project_get_has_selection ##### --> +<para> + +</para> + +@project: +@Returns: + + <!-- ##### FUNCTION glade_project_set_accel_group ##### --> <para> @@ -366,7 +452,7 @@ object and its signals. @Returns: -<!-- ##### FUNCTION glade_project_get_has_selection ##### --> +<!-- ##### FUNCTION glade_project_get_file_mtime ##### --> <para> </para> @@ -375,7 +461,25 @@ object and its signals. @Returns: -<!-- ##### FUNCTION glade_project_get_readonly ##### --> +<!-- ##### FUNCTION glade_project_get_instance_count ##### --> +<para> + +</para> + +@project: +@Returns: + + +<!-- ##### FUNCTION glade_project_set_instance_count ##### --> +<para> + +</para> + +@project: +@instance_count: + + +<!-- ##### FUNCTION glade_project_get_modified ##### --> <para> </para> diff --git a/doc/tmpl/glade-property-class.sgml b/doc/tmpl/glade-property-class.sgml index c9e88b76..3865e9dc 100644 --- a/doc/tmpl/glade-property-class.sgml +++ b/doc/tmpl/glade-property-class.sgml @@ -1,15 +1,12 @@ <!-- ##### SECTION Title ##### --> -GladePropertyClass +GladeProperty <!-- ##### SECTION Short_Description ##### --> -Property Class-wide metadata + <!-- ##### SECTION Long_Description ##### --> <para> -#GladePropertyClass is a structure based on a #GParamSpec and parameters -from the Glade catalog files and describes how properties are to be handled -in Glade; it also provides an interface to convert #GValue to strings and -va_lists etc (back and forth). + </para> <!-- ##### SECTION See_Also ##### --> @@ -20,38 +17,19 @@ va_lists etc (back and forth). <!-- ##### SECTION Stability_Level ##### --> -<!-- ##### STRUCT GladePropertyClass ##### --> +<!-- ##### MACRO GPC_OBJECT_DELIMITER ##### --> <para> </para> -@type: -@handle: -@pspec: -@id: -@name: -@tooltip: -@virt: -@def: -@orig_def: -@parameters: -@displayable_values: -@query: -@optional: -@optional_default: -@construct_only: -@common: -@packing: -@translatable: -@visible_lines: -@save: -@save_always: -@visible: -@ignore: -@is_modified: -@resource: -@transfer_on_paste: -@weight: + + +<!-- ##### MACRO GPC_PROPERTY_NAMELEN ##### --> +<para> + +</para> + + <!-- ##### ENUM GPCType ##### --> <para> @@ -64,56 +42,42 @@ va_lists etc (back and forth). @GPC_ATK_ACTION: @GPC_ACCEL_PROPERTY: -<!-- ##### USER_FUNCTION GladeVerifyPropertyFunc ##### --> +<!-- ##### FUNCTION glade_property_class_new ##### --> <para> </para> -@adaptor: -@object: -@property_name: -@value: +@handle: @Returns: -<!-- ##### USER_FUNCTION GladeGetPropertyFunc ##### --> -<para> - -</para> - -@adaptor: -@object: -@property_name: -@value: - - -<!-- ##### USER_FUNCTION GladeSetPropertyFunc ##### --> +<!-- ##### FUNCTION glade_property_class_new_from_spec ##### --> <para> </para> -@adaptor: -@object: -@property_name: -@value: +@handle: +@spec: +@Returns: -<!-- ##### FUNCTION glade_property_class_new ##### --> +<!-- ##### FUNCTION glade_property_class_list_atk_relations ##### --> <para> </para> @handle: +@owner_type: @Returns: -<!-- ##### FUNCTION glade_property_class_new_from_spec ##### --> +<!-- ##### FUNCTION glade_property_class_accel_property ##### --> <para> </para> @handle: -@spec: +@owner_type: @Returns: @@ -193,24 +157,24 @@ va_lists etc (back and forth). @vl: -<!-- ##### FUNCTION glade_property_class_get_from_gvalue ##### --> +<!-- ##### FUNCTION glade_property_class_make_gvalue ##### --> <para> </para> @klass: -@value: @Varargs: +@Returns: -<!-- ##### FUNCTION glade_property_class_make_gvalue ##### --> +<!-- ##### FUNCTION glade_property_class_get_from_gvalue ##### --> <para> </para> @klass: +@value: @Varargs: -@Returns: <!-- ##### FUNCTION glade_property_class_update_from_node ##### --> @@ -274,23 +238,3 @@ va_lists etc (back and forth). @Returns: -<!-- ##### FUNCTION glade_property_class_list_atk_relations ##### --> -<para> - -</para> - -@handle: -@owner_type: -@Returns: - - -<!-- ##### FUNCTION glade_property_class_accel_property ##### --> -<para> - -</para> - -@handle: -@owner_type: -@Returns: - - diff --git a/doc/tmpl/glade-property.sgml b/doc/tmpl/glade-property.sgml index d446a528..5119cc57 100644 --- a/doc/tmpl/glade-property.sgml +++ b/doc/tmpl/glade-property.sgml @@ -1,18 +1,12 @@ <!-- ##### SECTION Title ##### --> -GladeProperty +glade-property <!-- ##### SECTION Short_Description ##### --> -An interface to properties on the #GladeWidget + <!-- ##### SECTION Long_Description ##### --> <para> -Every object property of every #GladeWidget in every #GladeProject has -a #GladeProperty to interface with, #GladeProperty provides a means -to handle properties in the runtime environment. -</para> -<para> -A #GladeProperty can be seen as an instance of a #GladePropertyClass, -the #GladePropertyClass describes how a #GladeProperty will function. + </para> <!-- ##### SECTION See_Also ##### --> @@ -23,6 +17,48 @@ the #GladePropertyClass describes how a #GladeProperty will function. <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### MACRO GLADE_PROPERTY_KLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO GLADE_IS_PROPERTY_KLASS ##### --> +<para> + +</para> + +@klass: + + +<!-- ##### MACRO GLADE_PROPERTY_GET_KLASS ##### --> +<para> + +</para> + +@o: + + +<!-- ##### STRUCT GladePropertyKlass ##### --> +<para> + +</para> + +@parent_class: +@dup: +@equals_value: +@set_value: +@get_value: +@get_default: +@sync: +@load: +@write: +@get_tooltip: +@value_changed: +@tooltip_changed: + <!-- ##### STRUCT GladeProperty ##### --> <para> @@ -44,7 +80,7 @@ the #GladePropertyClass describes how a #GladeProperty will function. @gladeproperty: the object which received the signal. @arg1: -@Param3: +@arg2: <!-- ##### ARG GladeProperty:enabled ##### --> <para> @@ -100,6 +136,14 @@ the #GladePropertyClass describes how a #GladeProperty will function. @property: +<!-- ##### FUNCTION glade_property_original_reset ##### --> +<para> + +</para> + +@property: + + <!-- ##### FUNCTION glade_property_default ##### --> <para> @@ -109,6 +153,15 @@ the #GladePropertyClass describes how a #GladeProperty will function. @Returns: +<!-- ##### FUNCTION glade_property_original_default ##### --> +<para> + +</para> + +@property: +@Returns: + + <!-- ##### FUNCTION glade_property_equals_value ##### --> <para> @@ -250,29 +303,26 @@ the #GladePropertyClass describes how a #GladeProperty will function. @Returns: -<!-- ##### FUNCTION glade_property_superuser ##### --> +<!-- ##### FUNCTION glade_property_get_tooltip ##### --> <para> </para> +@property: @Returns: -<!-- ##### FUNCTION glade_property_push_superuser ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION glade_property_pop_superuser ##### --> +<!-- ##### FUNCTION glade_property_set_sensitive ##### --> <para> </para> +@property: +@sensitive: +@reason: -<!-- ##### FUNCTION glade_property_get_tooltip ##### --> +<!-- ##### FUNCTION glade_property_get_sensitive ##### --> <para> </para> @@ -281,17 +331,16 @@ the #GladePropertyClass describes how a #GladeProperty will function. @Returns: -<!-- ##### FUNCTION glade_property_set_sensitive ##### --> +<!-- ##### FUNCTION glade_property_set_save_always ##### --> <para> </para> @property: -@sensitive: -@reason: +@setting: -<!-- ##### FUNCTION glade_property_get_sensitive ##### --> +<!-- ##### FUNCTION glade_property_get_save_always ##### --> <para> </para> @@ -372,3 +421,25 @@ the #GladePropertyClass describes how a #GladeProperty will function. @Returns: +<!-- ##### FUNCTION glade_property_push_superuser ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION glade_property_pop_superuser ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION glade_property_superuser ##### --> +<para> + +</para> + +@Returns: + + diff --git a/doc/tmpl/glade-signal-editor.sgml b/doc/tmpl/glade-signal-editor.sgml index 43f1ef88..a404adbb 100644 --- a/doc/tmpl/glade-signal-editor.sgml +++ b/doc/tmpl/glade-signal-editor.sgml @@ -1,14 +1,12 @@ <!-- ##### SECTION Title ##### --> -Glade Signal Editor +glade-signal-editor <!-- ##### SECTION Short_Description ##### --> -An interface to edit signals for a #GladeWidget + <!-- ##### SECTION Long_Description ##### --> <para> -This isnt really a dockable widget, since you need to access the -#GladeSignalEditor struct's '->main_window' widget, the signal editor -is mostly of interest when implementing a custom object editor. + </para> <!-- ##### SECTION See_Also ##### --> diff --git a/doc/tmpl/glade-utils.sgml b/doc/tmpl/glade-utils.sgml index ca325fce..80b8558c 100644 --- a/doc/tmpl/glade-utils.sgml +++ b/doc/tmpl/glade-utils.sgml @@ -1,12 +1,12 @@ <!-- ##### SECTION Title ##### --> -Utilities +glade-utils <!-- ##### SECTION Short_Description ##### --> -Welcome to the zoo + <!-- ##### SECTION Long_Description ##### --> <para> -This is where all of that really usefull miscalanious stuff lands up. + </para> <!-- ##### SECTION See_Also ##### --> @@ -17,6 +17,25 @@ This is where all of that really usefull miscalanious stuff lands up. <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### ENUM GladeUtilFileDialogType ##### --> +<para> + +</para> + +@GLADE_FILE_DIALOG_ACTION_OPEN: +@GLADE_FILE_DIALOG_ACTION_SAVE: + +<!-- ##### ENUM GladeUIMessageType ##### --> +<para> + +</para> + +@GLADE_UI_INFO: +@GLADE_UI_WARN: +@GLADE_UI_ERROR: +@GLADE_UI_ARE_YOU_SURE: +@GLADE_UI_YES_OR_NO: + <!-- ##### FUNCTION glade_util_widget_set_tooltip ##### --> <para> @@ -45,17 +64,6 @@ This is where all of that really usefull miscalanious stuff lands up. @Returns: -<!-- ##### ENUM GladeUIMessageType ##### --> -<para> - -</para> - -@GLADE_UI_INFO: -@GLADE_UI_WARN: -@GLADE_UI_ERROR: -@GLADE_UI_ARE_YOU_SURE: -@GLADE_UI_YES_OR_NO: - <!-- ##### FUNCTION glade_util_ui_message ##### --> <para> @@ -242,7 +250,7 @@ This is where all of that really usefull miscalanious stuff lands up. @Returns: -<!-- ##### FUNCTION glade_util_removed_from_list ##### --> +<!-- ##### FUNCTION glade_util_added_in_list ##### --> <para> </para> @@ -252,7 +260,7 @@ This is where all of that really usefull miscalanious stuff lands up. @Returns: -<!-- ##### FUNCTION glade_util_added_in_list ##### --> +<!-- ##### FUNCTION glade_util_removed_from_list ##### --> <para> </para> @@ -281,12 +289,13 @@ This is where all of that really usefull miscalanious stuff lands up. @Returns: -<!-- ##### FUNCTION glade_util_file_is_writeable ##### --> +<!-- ##### FUNCTION glade_util_class_implements_interface ##### --> <para> </para> -@path: +@class_type: +@iface_type: @Returns: @@ -299,13 +308,12 @@ This is where all of that really usefull miscalanious stuff lands up. @Returns: -<!-- ##### FUNCTION glade_util_class_implements_interface ##### --> +<!-- ##### FUNCTION glade_util_file_is_writeable ##### --> <para> </para> -@class_type: -@iface_type: +@path: @Returns: @@ -317,6 +325,15 @@ This is where all of that really usefull miscalanious stuff lands up. @Returns: +<!-- ##### FUNCTION glade_util_get_devhelp_icon ##### --> +<para> + +</para> + +@size: +@Returns: + + <!-- ##### FUNCTION glade_util_search_devhelp ##### --> <para> @@ -327,3 +344,40 @@ This is where all of that really usefull miscalanious stuff lands up. @search: +<!-- ##### FUNCTION glade_util_get_placeholder_from_pointer ##### --> +<para> + +</para> + +@container: +@Returns: + + +<!-- ##### FUNCTION glade_util_object_is_loading ##### --> +<para> + +</para> + +@object: +@Returns: + + +<!-- ##### FUNCTION glade_util_url_show ##### --> +<para> + +</para> + +@url: +@Returns: + + +<!-- ##### FUNCTION glade_util_get_file_mtime ##### --> +<para> + +</para> + +@filename: +@error: +@Returns: + + diff --git a/doc/tmpl/glade-widget-action.sgml b/doc/tmpl/glade-widget-action.sgml new file mode 100644 index 00000000..cb1d0590 --- /dev/null +++ b/doc/tmpl/glade-widget-action.sgml @@ -0,0 +1,65 @@ +<!-- ##### SECTION Title ##### --> +GladeWidgetAction + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT GladeWidgetAction ##### --> +<para> + +</para> + +@parent_instance: +@klass: +@sensitive: +@actions: + +<!-- ##### FUNCTION glade_widget_action_class_free ##### --> +<para> + +</para> + +@action: + + +<!-- ##### FUNCTION glade_widget_action_class_clone ##### --> +<para> + +</para> + +@action: +@Returns: + + +<!-- ##### FUNCTION glade_widget_action_remove ##### --> +<para> + +</para> + +@action: +@child: +@Returns: + + +<!-- ##### FUNCTION glade_widget_action_set_sensitive ##### --> +<para> + +</para> + +@action: +@sensitive: + + diff --git a/doc/tmpl/glade-widget-adaptor.sgml b/doc/tmpl/glade-widget-adaptor.sgml new file mode 100644 index 00000000..c0889475 --- /dev/null +++ b/doc/tmpl/glade-widget-adaptor.sgml @@ -0,0 +1,659 @@ +<!-- ##### SECTION Title ##### --> +GladeWidgetAdaptor + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT GladeWidgetAdaptorPrivate ##### --> +<para> + +</para> + + +<!-- ##### MACRO GWA_IS_FIXED ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO GWA_IS_TOPLEVEL ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO GWA_USE_PLACEHOLDERS ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO GWA_DEFAULT_WIDTH ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO GWA_DEFAULT_HEIGHT ##### --> +<para> + +</para> + +@obj: + + +<!-- ##### MACRO GWA_GET_CLASS ##### --> +<para> + +</para> + +@type: + + +<!-- ##### MACRO GWA_GET_OCLASS ##### --> +<para> + +</para> + +@type: + + +<!-- ##### MACRO GLADE_VALID_CREATE_REASON ##### --> +<para> + +</para> + +@reason: + + +<!-- ##### ENUM GladeCreateReason ##### --> +<para> + +</para> + +@GLADE_CREATE_USER: +@GLADE_CREATE_COPY: +@GLADE_CREATE_LOAD: +@GLADE_CREATE_REBUILD: +@GLADE_CREATE_REASONS: + +<!-- ##### MACRO GLADE_TYPE_CREATE_REASON ##### --> +<para> + +</para> + + + +<!-- ##### USER_FUNCTION GladeSetPropertyFunc ##### --> +<para> + +</para> + +@adaptor: +@object: +@property_name: +@value: + + +<!-- ##### USER_FUNCTION GladeGetPropertyFunc ##### --> +<para> + +</para> + +@adaptor: +@object: +@property_name: +@value: + + +<!-- ##### USER_FUNCTION GladeVerifyPropertyFunc ##### --> +<para> + +</para> + +@adaptor: +@object: +@property_name: +@value: +@Returns: + + +<!-- ##### USER_FUNCTION GladeChildSetPropertyFunc ##### --> +<para> + +</para> + +@adaptor: +@container: +@child: +@property_name: +@value: + + +<!-- ##### USER_FUNCTION GladeChildGetPropertyFunc ##### --> +<para> + +</para> + +@adaptor: +@container: +@child: +@property_name: +@value: + + +<!-- ##### USER_FUNCTION GladeChildVerifyPropertyFunc ##### --> +<para> + +</para> + +@adaptor: +@container: +@child: +@property_name: +@value: +@Returns: + + +<!-- ##### USER_FUNCTION GladeGetChildrenFunc ##### --> +<para> + +</para> + +@adaptor: +@container: +@Returns: + + +<!-- ##### USER_FUNCTION GladeAddChildFunc ##### --> +<para> + +</para> + +@adaptor: +@parent: +@child: + + +<!-- ##### USER_FUNCTION GladeRemoveChildFunc ##### --> +<para> + +</para> + +@adaptor: +@parent: +@child: + + +<!-- ##### USER_FUNCTION GladeReplaceChildFunc ##### --> +<para> + +</para> + +@adaptor: +@container: +@old_obj: +@new_obj: + + +<!-- ##### USER_FUNCTION GladePostCreateFunc ##### --> +<para> + +</para> + +@adaptor: +@object: +@reason: + + +<!-- ##### USER_FUNCTION GladeGetInternalFunc ##### --> +<para> + +</para> + +@adaptor: +@parent: +@name: +@Returns: + + +<!-- ##### USER_FUNCTION GladeActionActivateFunc ##### --> +<para> + +</para> + +@adaptor: +@object: +@action_path: + + +<!-- ##### USER_FUNCTION GladeChildActionActivateFunc ##### --> +<para> + +</para> + +@adaptor: +@container: +@object: +@action_path: + + +<!-- ##### STRUCT GladeWidgetAdaptor ##### --> +<para> + +</para> + +@parent_instance: +@type: +@name: +@generic_name: +@icon_name: +@title: +@properties: +@packing_props: +@signals: +@child_packings: +@actions: +@packing_actions: +@priv: + +<!-- ##### MACRO glade_widget_adaptor_create_widget ##### --> +<para> + +</para> + +@adaptor: +@query: +@...: + + +<!-- ##### MACRO glade_widget_adaptor_from_pclass ##### --> +<para> + +</para> + +@pclass: + + +<!-- ##### MACRO glade_widget_adaptor_from_pspec ##### --> +<para> + +</para> + +@pspec: + + +<!-- ##### FUNCTION glade_create_reason_get_type ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_from_catalog ##### --> +<para> + +</para> + +@class_node: +@catname: +@icon_prefix: +@module: +@domain: +@book: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_register ##### --> +<para> + +</para> + +@adaptor: + + +<!-- ##### FUNCTION glade_widget_adaptor_create_internal ##### --> +<para> + +</para> + +@parent: +@internal_object: +@internal_name: +@parent_name: +@anarchist: +@reason: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_create_widget_real ##### --> +<para> + +</para> + +@query: +@first_property: +@Varargs: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_get_by_name ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_get_by_type ##### --> +<para> + +</para> + +@type: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_get_property_class ##### --> +<para> + +</para> + +@adaptor: +@name: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_get_pack_property_class ##### --> +<para> + +</para> + +@adaptor: +@name: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_default_params ##### --> +<para> + +</para> + +@adaptor: +@construct: +@n_params: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_post_create ##### --> +<para> + +</para> + +@adaptor: +@object: +@reason: + + +<!-- ##### FUNCTION glade_widget_adaptor_get_internal_child ##### --> +<para> + +</para> + +@adaptor: +@object: +@internal_name: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_set_property ##### --> +<para> + +</para> + +@adaptor: +@object: +@property_name: +@value: + + +<!-- ##### FUNCTION glade_widget_adaptor_get_property ##### --> +<para> + +</para> + +@adaptor: +@object: +@property_name: +@value: + + +<!-- ##### FUNCTION glade_widget_adaptor_verify_property ##### --> +<para> + +</para> + +@adaptor: +@object: +@property_name: +@value: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_add ##### --> +<para> + +</para> + +@adaptor: +@container: +@child: + + +<!-- ##### FUNCTION glade_widget_adaptor_remove ##### --> +<para> + +</para> + +@adaptor: +@container: +@child: + + +<!-- ##### FUNCTION glade_widget_adaptor_get_children ##### --> +<para> + +</para> + +@adaptor: +@container: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_has_child ##### --> +<para> + +</para> + +@adaptor: +@container: +@child: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_child_set_property ##### --> +<para> + +</para> + +@adaptor: +@container: +@child: +@property_name: +@value: + + +<!-- ##### FUNCTION glade_widget_adaptor_child_get_property ##### --> +<para> + +</para> + +@adaptor: +@container: +@child: +@property_name: +@value: + + +<!-- ##### FUNCTION glade_widget_adaptor_child_verify_property ##### --> +<para> + +</para> + +@adaptor: +@container: +@child: +@property_name: +@value: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_replace_child ##### --> +<para> + +</para> + +@adaptor: +@container: +@old_obj: +@new_obj: + + +<!-- ##### FUNCTION glade_widget_adaptor_query ##### --> +<para> + +</para> + +@adaptor: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_get_packing_default ##### --> +<para> + +</para> + +@child_adaptor: +@container_adaptor: +@id: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_is_container ##### --> +<para> + +</para> + +@adaptor: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_action_add ##### --> +<para> + +</para> + +@adaptor: +@action_path: +@label: +@stock: +@important: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_pack_action_add ##### --> +<para> + +</para> + +@adaptor: +@action_path: +@label: +@stock: +@important: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_action_remove ##### --> +<para> + +</para> + +@adaptor: +@action_path: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_pack_action_remove ##### --> +<para> + +</para> + +@adaptor: +@action_path: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_pack_actions_new ##### --> +<para> + +</para> + +@adaptor: +@Returns: + + +<!-- ##### FUNCTION glade_widget_adaptor_action_activate ##### --> +<para> + +</para> + +@adaptor: +@object: +@action_path: + + +<!-- ##### FUNCTION glade_widget_adaptor_child_action_activate ##### --> +<para> + +</para> + +@adaptor: +@container: +@object: +@action_path: + + diff --git a/doc/tmpl/glade-widget.sgml b/doc/tmpl/glade-widget.sgml index 5f015c29..c1b3717a 100644 --- a/doc/tmpl/glade-widget.sgml +++ b/doc/tmpl/glade-widget.sgml @@ -2,13 +2,11 @@ GladeWidget <!-- ##### SECTION Short_Description ##### --> -An object wrapper for the Glade runtime environment. + <!-- ##### SECTION Long_Description ##### --> <para> -#GladeWidget is the proxy between the instantiated runtime object and -the Glade core metadata. This api will be mostly usefull for its -convenience api for getting and setting properties (mostly from the plugin). + </para> <!-- ##### SECTION See_Also ##### --> @@ -175,85 +173,118 @@ convenience api for getting and setting properties (mostly from the plugin). @child: -<!-- ##### FUNCTION glade_widget_set_name ##### --> +<!-- ##### FUNCTION glade_widget_write ##### --> <para> </para> @widget: -@name: +@interface: +@Returns: -<!-- ##### FUNCTION glade_widget_set_internal ##### --> +<!-- ##### FUNCTION glade_widget_read ##### --> <para> </para> -@widget: -@internal: +@project: +@info: +@Returns: -<!-- ##### FUNCTION glade_widget_set_object ##### --> +<!-- ##### FUNCTION glade_widget_replace ##### --> <para> </para> -@gwidget: +@parent: +@old_object: @new_object: -<!-- ##### FUNCTION glade_widget_set_project ##### --> +<!-- ##### FUNCTION glade_widget_rebuild ##### --> +<para> + +</para> + +@gwidget: + + +<!-- ##### FUNCTION glade_widget_dup ##### --> +<para> + +</para> + +@template_widget: +@exact: +@Returns: + + +<!-- ##### FUNCTION glade_widget_copy_signals ##### --> <para> </para> @widget: -@project: +@template_widget: -<!-- ##### FUNCTION glade_widget_get_name ##### --> +<!-- ##### FUNCTION glade_widget_copy_properties ##### --> <para> </para> @widget: -@Returns: +@template_widget: -<!-- ##### FUNCTION glade_widget_get_internal ##### --> +<!-- ##### FUNCTION glade_widget_set_packing_properties ##### --> <para> </para> @widget: -@Returns: +@container: -<!-- ##### FUNCTION glade_widget_get_project ##### --> +<!-- ##### FUNCTION glade_widget_get_property ##### --> <para> </para> @widget: +@id_property: @Returns: -<!-- ##### FUNCTION glade_widget_get_object ##### --> +<!-- ##### FUNCTION glade_widget_get_pack_property ##### --> <para> </para> @widget: +@id_property: @Returns: -<!-- ##### FUNCTION glade_widget_project_notify ##### --> +<!-- ##### FUNCTION glade_widget_dup_properties ##### --> +<para> + +</para> + +@template_props: +@as_load: +@Returns: + + +<!-- ##### FUNCTION glade_widget_remove_property ##### --> <para> </para> @widget: -@project: +@id_property: <!-- ##### FUNCTION glade_widget_show ##### --> @@ -272,22 +303,151 @@ convenience api for getting and setting properties (mostly from the plugin). @widget: -<!-- ##### FUNCTION glade_widget_copy_properties ##### --> +<!-- ##### FUNCTION glade_widget_add_signal_handler ##### --> <para> </para> @widget: -@template_widget: +@signal_handler: -<!-- ##### FUNCTION glade_widget_set_packing_properties ##### --> +<!-- ##### FUNCTION glade_widget_remove_signal_handler ##### --> <para> </para> @widget: -@container: +@signal_handler: + + +<!-- ##### FUNCTION glade_widget_change_signal_handler ##### --> +<para> + +</para> + +@widget: +@old_signal_handler: +@new_signal_handler: + + +<!-- ##### FUNCTION glade_widget_list_signal_handlers ##### --> +<para> + +</para> + +@widget: +@signal_name: +@Returns: + + +<!-- ##### FUNCTION glade_widget_has_decendant ##### --> +<para> + +</para> + +@widget: +@type: +@Returns: + + +<!-- ##### FUNCTION glade_widget_event ##### --> +<para> + +</para> + +@gwidget: +@event: +@Returns: + + +<!-- ##### FUNCTION glade_widget_placeholder_relation ##### --> +<para> + +</para> + +@parent: +@widget: +@Returns: + + +<!-- ##### FUNCTION glade_widget_get_action ##### --> +<para> + +</para> + +@widget: +@action_path: +@Returns: + + +<!-- ##### FUNCTION glade_widget_get_pack_action ##### --> +<para> + +</para> + +@widget: +@action_path: +@Returns: + + +<!-- ##### FUNCTION glade_widget_set_action_sensitive ##### --> +<para> + +</para> + +@widget: +@action_path: +@sensitive: +@Returns: + + +<!-- ##### FUNCTION glade_widget_set_pack_action_sensitive ##### --> +<para> + +</para> + +@widget: +@action_path: +@sensitive: +@Returns: + + +<!-- ##### FUNCTION glade_widget_remove_action ##### --> +<para> + +</para> + +@widget: +@action_path: + + +<!-- ##### FUNCTION glade_widget_remove_pack_action ##### --> +<para> + +</para> + +@widget: +@action_path: + + +<!-- ##### FUNCTION glade_widget_create_action_menu ##### --> +<para> + +</para> + +@widget: +@action_path: +@Returns: + + +<!-- ##### FUNCTION glade_widget_project_notify ##### --> +<para> + +</para> + +@widget: +@project: <!-- ##### FUNCTION glade_widget_add_prop_ref ##### --> @@ -308,24 +468,46 @@ convenience api for getting and setting properties (mostly from the plugin). @property: -<!-- ##### FUNCTION glade_widget_get_property ##### --> +<!-- ##### FUNCTION glade_widget_object_set_property ##### --> <para> </para> @widget: -@id_property: -@Returns: +@property_name: +@value: -<!-- ##### FUNCTION glade_widget_get_pack_property ##### --> +<!-- ##### FUNCTION glade_widget_object_get_property ##### --> <para> </para> @widget: -@id_property: -@Returns: +@property_name: +@value: + + +<!-- ##### FUNCTION glade_widget_child_set_property ##### --> +<para> + +</para> + +@widget: +@child: +@property_name: +@value: + + +<!-- ##### FUNCTION glade_widget_child_get_property ##### --> +<para> + +</para> + +@widget: +@child: +@property_name: +@value: <!-- ##### FUNCTION glade_widget_property_get ##### --> @@ -402,6 +584,16 @@ convenience api for getting and setting properties (mostly from the plugin). @Returns: +<!-- ##### FUNCTION glade_widget_property_original_default ##### --> +<para> + +</para> + +@widget: +@id_property: +@Returns: + + <!-- ##### FUNCTION glade_widget_pack_property_default ##### --> <para> @@ -458,99 +650,128 @@ convenience api for getting and setting properties (mostly from the plugin). @Returns: -<!-- ##### FUNCTION glade_widget_has_decendant ##### --> +<!-- ##### FUNCTION glade_widget_property_set_save_always ##### --> <para> </para> @widget: -@type: +@id_property: +@setting: @Returns: -<!-- ##### FUNCTION glade_widget_replace ##### --> +<!-- ##### FUNCTION glade_widget_pack_property_set_save_always ##### --> <para> </para> -@parent: -@old_object: -@new_object: +@widget: +@id_property: +@setting: +@Returns: -<!-- ##### FUNCTION glade_widget_rebuild ##### --> +<!-- ##### FUNCTION glade_widget_property_string ##### --> <para> </para> -@gwidget: +@widget: +@id_property: +@value: +@Returns: -<!-- ##### FUNCTION glade_widget_dup ##### --> +<!-- ##### FUNCTION glade_widget_pack_property_string ##### --> <para> </para> -@template_widget: -@exact: +@widget: +@id_property: +@value: @Returns: -<!-- ##### FUNCTION glade_widget_add_signal_handler ##### --> +<!-- ##### FUNCTION glade_widget_set_name ##### --> <para> </para> @widget: -@signal_handler: +@name: -<!-- ##### FUNCTION glade_widget_remove_signal_handler ##### --> +<!-- ##### FUNCTION glade_widget_get_name ##### --> <para> </para> @widget: -@signal_handler: +@Returns: -<!-- ##### FUNCTION glade_widget_change_signal_handler ##### --> +<!-- ##### FUNCTION glade_widget_set_internal ##### --> <para> </para> @widget: -@old_signal_handler: -@new_signal_handler: +@internal: -<!-- ##### FUNCTION glade_widget_list_signal_handlers ##### --> +<!-- ##### FUNCTION glade_widget_get_internal ##### --> <para> </para> @widget: -@signal_name: @Returns: -<!-- ##### FUNCTION glade_widget_write ##### --> +<!-- ##### FUNCTION glade_widget_set_object ##### --> +<para> + +</para> + +@gwidget: +@new_object: + + +<!-- ##### FUNCTION glade_widget_get_object ##### --> <para> </para> @widget: -@interface: @Returns: -<!-- ##### FUNCTION glade_widget_read ##### --> +<!-- ##### FUNCTION glade_widget_set_project ##### --> <para> </para> +@widget: @project: -@info: + + +<!-- ##### FUNCTION glade_widget_get_project ##### --> +<para> + +</para> + +@widget: +@Returns: + + +<!-- ##### FUNCTION glade_widget_get_adaptor ##### --> +<para> + +</para> + +@widget: @Returns: diff --git a/doc/tmpl/gladeui-unused.sgml b/doc/tmpl/gladeui-unused.sgml index 6bf1e8da..3ea23c65 100644 --- a/doc/tmpl/gladeui-unused.sgml +++ b/doc/tmpl/gladeui-unused.sgml @@ -1,129 +1,54 @@ -<!-- ##### SECTION ./tmpl/glade-project-view.sgml:Long_Description ##### --> +<!-- ##### SECTION ./tmpl/glade-widget-class.sgml:Long_Description ##### --> <para> -The #GladeProjectView is a heirarchical treeview that allows the -user to control selection and cut/copy/paste/delete #GladeWidget -objects in the #GladeProject. +#GladeWidgetClass is a structure based on a #GType and parameters +from the Glade catalog files and is the central metadata for object +classes; it also provides an abstraction later to container apis. </para> -<!-- ##### SECTION ./tmpl/glade-project-view.sgml:See_Also ##### --> +<!-- ##### SECTION ./tmpl/glade-widget-class.sgml:See_Also ##### --> <para> </para> -<!-- ##### SECTION ./tmpl/glade-project-view.sgml:Short_Description ##### --> -A widget to view the project hierarchy +<!-- ##### SECTION ./tmpl/glade-widget-class.sgml:Short_Description ##### --> +Object Class-wide metadata -<!-- ##### SECTION ./tmpl/glade-project-view.sgml:Stability_Level ##### --> +<!-- ##### SECTION ./tmpl/glade-widget-class.sgml:Stability_Level ##### --> -<!-- ##### SECTION ./tmpl/glade-project-view.sgml:Title ##### --> -GladeProjectView +<!-- ##### SECTION ./tmpl/glade-widget-class.sgml:Title ##### --> +GladeWidgetClass -<!-- ##### SIGNAL GladeApp::widget-event ##### --> +<!-- ##### STRUCT GladeSignalClass ##### --> <para> </para> -@gladeapp: the object which received the signal. -@arg1: -@event: -@Returns: - -<!-- ##### USER_FUNCTION GladeEditorLaunchFunc ##### --> -<para> - -</para> - -@adaptor: -@object: - -<!-- ##### ARG GladeFixed:use-placeholders ##### --> -<para> - -</para> - - -<!-- ##### ARG GladeProject:has-unsaved-changes ##### --> -<para> - -</para> - - -<!-- ##### SIGNAL GladeWidget::enter-notify-event ##### --> -<para> - -</para> - -@gladewidget: the object which received the signal. -@event: -@Returns: - -<!-- ##### FUNCTION glade_app_add_project_view ##### --> -<para> - -</para> - -@view: - -<!-- ##### FUNCTION glade_project_display_name ##### --> -<para> - -</para> - -@project: -@unsaved_changes: -@tab_aligned: -@mnemonic: -@Returns: - -<!-- ##### FUNCTION glade_project_open ##### --> -<para> - -</para> +@query: +@name: +@type: -@path: -@Returns: - -<!-- ##### FUNCTION glade_util_any_gtkcontainer_relation ##### --> +<!-- ##### STRUCT GladeWidgetClass ##### --> <para> </para> -@parent: -@widgets: -@Returns: - -<!-- ##### FUNCTION glade_util_deep_fixed_event ##### --> -<para> - -</para> - -@widget: +@parent_class: +@add_child: +@remove_child: +@replace_child: +@add_signal_handler: +@remove_signal_handler: +@change_signal_handler: +@button_press_event: +@button_release_event: +@motion_notify_event: @event: -@gwidget: -@Returns: - -<!-- ##### FUNCTION glade_util_get_parent ##### --> -<para> - -</para> - -@w: -@Returns: - -<!-- ##### FUNCTION glade_util_gtkcontainer_relation ##### --> -<para> - -</para> - -@parent: -@widget: -@Returns: <!-- ##### FUNCTION glade_util_queue_draw_nodes ##### --> <para> @@ -132,34 +57,3 @@ GladeProjectView @window: -<!-- ##### FUNCTION glade_util_widget_pastable ##### --> -<para> - -</para> - -@child: -@parent: -@Returns: - -<!-- ##### FUNCTION glade_widget_event_widget ##### --> -<para> - -</para> - -@Returns: - -<!-- ##### FUNCTION glade_widget_has_launcher ##### --> -<para> - -</para> - -@widget: -@Returns: - -<!-- ##### FUNCTION glade_widget_launch_editor ##### --> -<para> - -</para> - -@widget: - |