## cong-ui-hooks

cong-ui-hooks —

## Synopsis

    GtkMenuItem* cong_menu_item_attach_callback_Document
                                                (GtkMenuItem *item,
                                                 CongUICallback_Document callback,
                                                 CongDocument *doc);
    GtkMenuItem* cong_menu_item_attach_callback_Document_SelectedNode_ParentWindow
                                                (GtkMenuItem *item,
                                                 CongUICallback_Document_SelectedNode_ParentWindow callback,
                                                 CongDocument *doc,
                                                 GtkWindow *parent_window);
    GtkMenuItem* cong_menu_item_attach_callback_Document_ElementDescription_SelectedNode
                                                (GtkMenuItem *item,
                                                 CongUICallback_Document_ElementDescription_SelectedNode callback,
                                                 CongDocument *doc,
                                                 CongElementDescription *element_desc);
    void        cong_menu_add_item              (const gchar *parent_ui_path,
                                                 GtkAction *action);
    void        cong_ui_hook_file_import        (GtkWindow *toplevel_window);
    void        cong_ui_hook_file_export        (CongDocument *doc,
                                                 GtkWindow *toplevel_window);
    void        cong_ui_hook_file_print_preview (CongDocument *doc,
                                                 GtkWindow *toplevel_window);
    void        cong_ui_hook_file_print         (CongDocument *doc,
                                                 GtkWindow *toplevel_window);
    void        cong_ui_hook_edit_preferences   (GtkWindow *toplevel_window);
    void        cong_ui_hook_tree_new_sibling   (CongDocument *doc,
                                                 CongElementDescription *element_desc);
    void        cong_ui_hook_tree_new_sub_element
                                                (CongDocument *doc,
                                                 CongElementDescription *element_desc);
    void        cong_ui_hook_tree_properties    (CongDocument *doc,
                                                 GtkWindow *parent_window);
    void        cong_ui_hook_tree_cut           (CongDocument *doc,
                                                 GtkWindow *parent_window);
    void        cong_ui_hook_tree_copy          (CongDocument *doc,
                                                 GtkWindow *parent_window);
    void        cong_ui_hook_tree_paste_under   (CongDocument *doc,
                                                 GtkWindow *parent_window);
    void        cong_ui_hook_tree_paste_before  (CongDocument *doc,
                                                 GtkWindow *parent_window);
    void        cong_ui_hook_tree_paste_after   (CongDocument *doc,
                                                 GtkWindow *parent_window);
    void        cong_ui_hook_tree_convert_to_comment
                                                (CongDocument *doc,
                                                 GtkWindow *parent_window);
    void        cong_ui_hook_tree_convert_from_comment
                                                (CongDocument *doc,
                                                 GtkWindow *parent_window);
    gint        toolbar_callback_open           (GtkWidget *widget,
                                                 gpointer data);
    gint        toolbar_callback_new            (GtkWidget *w,
                                                 gpointer data);
    gint        toolbar_callback_save           (GtkWidget *w,
                                                 gpointer data);
    gint        toolbar_callback_cut            (GtkWidget *w,
                                                 gpointer data);
    gint        toolbar_callback_copy           (GtkWidget *w,
                                                 gpointer data);
    gint        toolbar_callback_paste          (GtkWidget *w,
                                                 gpointer data);
    void        menu_callback_debug_error       (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);
    void        menu_callback_debug_document_types
                                                (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);
    void        menu_callback_debug_transform_docbook_to_html
                                                (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);
    void        menu_callback_debug_transform_docbook_to_xhtml
                                                (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);
    void        menu_callback_debug_transform_docbook_to_html_help
                                                (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);
    void        menu_callback_debug_transform_docbook_to_javahelp
                                                (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);
    void        menu_callback_debug_transform_docbook_to_fo
                                                (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);
    void        menu_callback_debug_preview_fo  (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);
    void        cong_gnome_print_render_xslfo   (xmlDocPtr xml_doc,
                                                 GnomePrintMaster *gpm);
    void        menu_callback_debug_dtd         (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);
    void        menu_callback_debug_dialog      (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);
    guint       cong_menus_create_items         (CongPrimaryWindow *primary_window);
    void        editor_popup_show               (GtkWidget *widget,
                                                 GdkEventButton *bevent);
    void        editor_popup_init               ();
    void        cong_ui_popup_init              (CongDocument *doc,
                                                 CongNodePtr node,
                                                 GtkWindow *parent_window,
                                                 CongPrimaryWindow *primary_window);
    char*       tag_new_pick                    ();
    void        open_document                   (GtkWindow *parent_window);
    gint        save_document                   (CongDocument *doc,
                                                 GtkWindow *parent_window);
    gint        save_document_as                (CongDocument *doc,
                                                 GtkWindow *parent_window);
    char*       pick_structural_tag             (CongDispspec *ds);
    void        open_document_do                (const gchar *doc_name,
                                                 GtkWindow *parent_window);
    void        new_document                    (GtkWindow *parent_window);
    int         gui_window_new_document_make    ();
    GtkWidget*  cong_gui_get_a_window           (void);
    GtkWidget*  cong_file_properties_dialog_new (CongDocument *doc,
                                                 GtkWindow *parent_window);

## Description

## Details

### cong_menu_item_attach_callback_Document ()

    GtkMenuItem* cong_menu_item_attach_callback_Document
                                                (GtkMenuItem *item,
                                                 CongUICallback_Document callback,
                                                 CongDocument *doc);

`item` : |
`callback` : |
`doc` : |
Returns : |

### cong_menu_item_attach_callback_Document_SelectedNode_ParentWindow ()

    GtkMenuItem* cong_menu_item_attach_callback_Document_SelectedNode_ParentWindow
                                                (GtkMenuItem *item,
                                                 CongUICallback_Document_SelectedNode_ParentWindow callback,
                                                 CongDocument *doc,
                                                 GtkWindow *parent_window);

`item` : |
`callback` : |
`doc` : |
`parent_window` : |
Returns : |

### cong_menu_item_attach_callback_Document_ElementDescription_SelectedNode ()

    GtkMenuItem* cong_menu_item_attach_callback_Document_ElementDescription_SelectedNode
                                                (GtkMenuItem *item,
                                                 CongUICallback_Document_ElementDescription_SelectedNode callback,
                                                 CongDocument *doc,
                                                 CongElementDescription *element_desc);

`item` : |
`callback` : |
`doc` : |
`element_desc` : |
Returns : |

### cong_menu_add_item ()

    void        cong_menu_add_item              (const gchar *parent_ui_path,
                                                 GtkAction *action);

`parent_ui_path` : |
`action` : |

### cong_ui_hook_file_import ()

    void        cong_ui_hook_file_import        (GtkWindow *toplevel_window);

TODO: Write me

`toplevel_window` : |

### cong_ui_hook_file_export ()

    void        cong_ui_hook_file_export        (CongDocument *doc,
                                                 GtkWindow *toplevel_window);

Convert the document (`doc`) to a different format. A dialog is displayed that lists all the registered exporters for this document type. If the user does not cancel then we check to see if a filename was given; if it was not the user is returned to the dialog, otherwise the chosen exporter is called.

Open issues include: how to inform the user of what is going on, and whether we allow the user to stop an exporter whilst it is processing.

`doc` : |
`toplevel_window` : |

### cong_ui_hook_file_print_preview ()

    void        cong_ui_hook_file_print_preview (CongDocument *doc,
                                                 GtkWindow *toplevel_window);

TODO: Write me

`doc` : |
`toplevel_window` : |

### cong_ui_hook_file_print ()

    void        cong_ui_hook_file_print         (CongDocument *doc,
                                                 GtkWindow *toplevel_window);

TODO: Write me

`doc` : |
`toplevel_window` : |

### cong_ui_hook_edit_preferences ()

    void        cong_ui_hook_edit_preferences   (GtkWindow *toplevel_window);

Opens the Preferences dialog for Conglomerate

`toplevel_window` : |

### cong_ui_hook_tree_new_sibling ()

    void        cong_ui_hook_tree_new_sibling   (CongDocument *doc,
                                                 CongElementDescription *element_desc);

TODO: Write me

`doc` : |
`element_desc` : |

### cong_ui_hook_tree_new_sub_element ()

    void        cong_ui_hook_tree_new_sub_element
                                                (CongDocument *doc,
                                                 CongElementDescription *element_desc);

TODO: Write me

`doc` : |
`element_desc` : |

### cong_ui_hook_tree_properties ()

    void        cong_ui_hook_tree_properties    (CongDocument *doc,
                                                 GtkWindow *parent_window);

TODO: Write me

`doc` : |
`parent_window` : |

### cong_ui_hook_tree_cut ()

    void        cong_ui_hook_tree_cut           (CongDocument *doc,
                                                 GtkWindow *parent_window);

TODO: Write me

`doc` : |
`parent_window` : |

### cong_ui_hook_tree_copy ()

    void        cong_ui_hook_tree_copy          (CongDocument *doc,
                                                 GtkWindow *parent_window);

TODO: Write me

`doc` : |
`parent_window` : |

### cong_ui_hook_tree_paste_under ()

    void        cong_ui_hook_tree_paste_under   (CongDocument *doc,
                                                 GtkWindow *parent_window);

TODO: Write me

`doc` : |
`parent_window` : |

### cong_ui_hook_tree_paste_before ()

    void        cong_ui_hook_tree_paste_before  (CongDocument *doc,
                                                 GtkWindow *parent_window);

TODO: Write me

`doc` : |
`parent_window` : |

### cong_ui_hook_tree_paste_after ()

    void        cong_ui_hook_tree_paste_after   (CongDocument *doc,
                                                 GtkWindow *parent_window);

TODO: Write me

`doc` : |
`parent_window` : |

### cong_ui_hook_tree_convert_to_comment ()

    void        cong_ui_hook_tree_convert_to_comment
                                                (CongDocument *doc,
                                                 GtkWindow *parent_window);

`doc` : |
`parent_window` : |

### cong_ui_hook_tree_convert_from_comment ()

    void        cong_ui_hook_tree_convert_from_comment
                                                (CongDocument *doc,
                                                 GtkWindow *parent_window);

`doc` : |
`parent_window` : |

### toolbar_callback_open ()

    gint        toolbar_callback_open           (GtkWidget *widget,
                                                 gpointer data);

TODO: Write me

`widget` : |
`data` : |
Returns : |

### toolbar_callback_new ()

    gint        toolbar_callback_new            (GtkWidget *w,
                                                 gpointer data);

TODO: Write me

`w` : |
`data` : |
Returns : |

### toolbar_callback_save ()

    gint        toolbar_callback_save           (GtkWidget *w,
                                                 gpointer data);

TODO: Write me

`w` : |
`data` : |
Returns : |

### toolbar_callback_cut ()

    gint        toolbar_callback_cut            (GtkWidget *w,
                                                 gpointer data);

`w` : |
`data` : |
Returns : |

### toolbar_callback_copy ()

    gint        toolbar_callback_copy           (GtkWidget *w,
                                                 gpointer data);

`w` : |
`data` : |
Returns : |

### toolbar_callback_paste ()

    gint        toolbar_callback_paste          (GtkWidget *w,
                                                 gpointer data);

`w` : |
`data` : |
Returns : |

### menu_callback_debug_error ()

    void        menu_callback_debug_error       (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);

`callback_data` : |
`callback_action` : |
`widget` : |

### menu_callback_debug_document_types ()

    void        menu_callback_debug_document_types
                                                (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);

`callback_data` : |
`callback_action` : |
`widget` : |

### menu_callback_debug_transform_docbook_to_html ()

    void        menu_callback_debug_transform_docbook_to_html
                                                (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);

`callback_data` : |
`callback_action` : |
`widget` : |

### menu_callback_debug_transform_docbook_to_xhtml ()

    void        menu_callback_debug_transform_docbook_to_xhtml
                                                (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);

`callback_data` : |
`callback_action` : |
`widget` : |

### menu_callback_debug_transform_docbook_to_html_help ()

    void        menu_callback_debug_transform_docbook_to_html_help
                                                (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);

`callback_data` : |
`callback_action` : |
`widget` : |

### menu_callback_debug_transform_docbook_to_javahelp ()

    void        menu_callback_debug_transform_docbook_to_javahelp
                                                (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);

`callback_data` : |
`callback_action` : |
`widget` : |

### menu_callback_debug_transform_docbook_to_fo ()

    void        menu_callback_debug_transform_docbook_to_fo
                                                (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);

`callback_data` : |
`callback_action` : |
`widget` : |

### menu_callback_debug_preview_fo ()

    void        menu_callback_debug_preview_fo  (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);

`callback_data` : |
`callback_action` : |
`widget` : |

### cong_gnome_print_render_xslfo ()

    void        cong_gnome_print_render_xslfo   (xmlDocPtr xml_doc,
                                                 GnomePrintMaster *gpm);

`xml_doc` : |
`gpm` : |

### menu_callback_debug_dtd ()

    void        menu_callback_debug_dtd         (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);

`callback_data` : |
`callback_action` : |
`widget` : |

### menu_callback_debug_dialog ()

    void        menu_callback_debug_dialog      (gpointer callback_data,
                                                 guint callback_action,
                                                 GtkWidget *widget);

`callback_data` : |
`callback_action` : |
`widget` : |

### cong_menus_create_items ()

    guint       cong_menus_create_items         (CongPrimaryWindow *primary_window);

TODO: Write me

`primary_window` : |
Returns : |

### editor_popup_show ()

    void        editor_popup_show               (GtkWidget *widget,
                                                 GdkEventButton *bevent);

TODO: Write me

`widget` : |
`bevent` : |

### editor_popup_init ()

    void        editor_popup_init               ();

TODO: Write me

### cong_ui_popup_init ()

    void        cong_ui_popup_init              (CongDocument *doc,
                                                 CongNodePtr node,
                                                 GtkWindow *parent_window,
                                                 CongPrimaryWindow *primary_window);

TODO: Write me

`doc` : |
`node` : |
`parent_window` : |
`primary_window` : |

### tag_new_pick ()

    char*       tag_new_pick                    ();

Returns : |

### open_document ()

    void        open_document                   (GtkWindow *parent_window);

TODO: Write me

`parent_window` : |

### save_document ()

    gint        save_document                   (CongDocument *doc,
                                                 GtkWindow *parent_window);

TODO: Write me

`doc` : |
`parent_window` : |
Returns : |

### save_document_as ()

    gint        save_document_as                (CongDocument *doc,
                                                 GtkWindow *parent_window);

TODO: Write me

`doc` : |
`parent_window` : |
Returns : |

### pick_structural_tag ()

    char*       pick_structural_tag             (CongDispspec *ds);

`ds` : |
Returns : |

### open_document_do ()

    void        open_document_do                (const gchar *doc_name,
                                                 GtkWindow *parent_window);

TODO: Write me

`doc_name` : |
`parent_window` : |

### new_document ()

    void        new_document                    (GtkWindow *parent_window);

TODO: Write me

`parent_window` : |

### gui_window_new_document_make ()

    int         gui_window_new_document_make    ();

Returns : |

### cong_gui_get_a_window ()

    GtkWidget*  cong_gui_get_a_window           (void);

TODO: Write me

Returns : |

### cong_file_properties_dialog_new ()

    GtkWidget*  cong_file_properties_dialog_new (CongDocument *doc,
                                                 GtkWindow *parent_window);

TODO: Write me

`doc` : |
`parent_window` : |
Returns : |