#include "ut_compiler.h"
#include <gtk/gtk.h>
#include <gdk/gdk.h>
#include <functional>
#include "ut_types.h"
#include "xap_Strings.h"

Defines
#define	SETUP_UNIX_STRING gchar * newstr = NULL;
#define	CONVERT_TO_UNIX_STRING(str, id, newstr)
#define	CONVERT_TO_ACC_STRING(str, id, newstr)
Functions
GtkBuilder *	newDialogBuilder (const char *name)
	load a GtkBuilder for a dialog using the standard path.
void	connectFocus (GtkWidget widget, const XAP_Frame frame)
void	connectFocusModeless (GtkWidget widget, const XAP_App pApp)
void	connectFocusModelessOther (GtkWidget widget, const XAP_App pApp, std::pointer_to_unary_function< int, gboolean > *other_function)
bool	isTransientWindow (GtkWindow window, GtkWindow parent)
void	messageBoxOK (const char *message)
void	centerDialog (GtkWidget parent, GtkWidget child, bool set_transient_for=true)
void	abiSetupModalDialog (GtkDialog me, XAP_Frame pFrame, XAP_Dialog *pDlg, gint dfl_id)
gint	abiRunModalDialog (GtkDialog *me, bool destroyDialog, AtkRole role=ATK_ROLE_DIALOG)
gint	abiRunModalDialog (GtkDialog me, XAP_Frame pFrame, XAP_Dialog *pDlg, gint dfl_id, bool destroyDialog, AtkRole role=ATK_ROLE_DIALOG)
void	abiSetupModelessDialog (GtkDialog me, XAP_Frame pFrame, XAP_Dialog *pDlg, gint dfl_id, bool abi_modeless=true, AtkRole role=ATK_ROLE_DIALOG)
void	abiDestroyWidget (GtkWidget *me)
GtkWidget *	abiAddButton (GtkDialog *me, std::string label, gint response_id)
GtkWidget *	abiDialogNew (const char *role, gboolean resizable=FALSE)
GtkWidget *	abiDialogNew (const char role, gboolean resizable, const char title,...)
GtkWidget *	abiGtkMenuFromCStrVector (const UT_GenericVector< const char * > &vec, GCallback cb, gpointer data)
void	abiDialogSetTitle (GtkWidget dlg, const char title,...) ABI_PRINTF_FORMAT(2
void void	convertMnemonics (gchar *s)
std::string &	convertMnemonics (std::string &s)
void	localizeLabel (GtkWidget widget, const XAP_StringSet pSS, XAP_String_Id id)
void	localizeLabelUnderline (GtkWidget widget, const XAP_StringSet pSS, XAP_String_Id id)
void	localizeLabelMarkup (GtkWidget widget, const XAP_StringSet pSS, XAP_String_Id id)
void	localizeButton (GtkWidget widget, const XAP_StringSet pSS, XAP_String_Id id)
void	localizeButtonUnderline (GtkWidget widget, const XAP_StringSet pSS, XAP_String_Id id)
void	localizeButtonMarkup (GtkWidget widget, const XAP_StringSet pSS, XAP_String_Id id)
void	localizeMenuItem (GtkWidget widget, const XAP_StringSet pSS, XAP_String_Id id)
void	setLabelMarkup (GtkWidget widget, const gchar str)
GdkWindow *	getRootWindow (GtkWidget *widget)
void	abiSetActivateOnWidgetToActivateButton (GtkWidget source, GtkWidget button)
	When the source widget gets the activate signal, sent activate to the button.

Define Documentation

#define CONVERT_TO_ACC_STRING	(	str,
		id,
		newstr
	)

Value:

do { \
                                                    FREEP(newstr); \
                                                    std::string _s;           \
                                                    pSS->getValueUTF8(id,_s); \
                                                    UT_XML_cloneConvAmpersands(newstr, _s.c_str()); \
                            } while (0);

Referenced by AP_UnixDialog_Replace::_constructWindow().

#define CONVERT_TO_UNIX_STRING	(	str,
		id,
		newstr
	)

Value:

do { \
                                                    FREEP(newstr); \
                                                    std::string _s;           \
                                                    pSS->getValueUTF8(id,_s); \
                                                    UT_XML_cloneNoAmpersands(newstr, _s.c_str()); \
                            } while (0);

Referenced by AP_UnixDialog_Replace::_constructWindow().

#define SETUP_UNIX_STRING gchar * newstr = NULL;

Function Documentation

GtkWidget* abiAddButton	(	GtkDialog *	me,
		std::string	label,
		gint	response_id
	)

Add this locale-sensitive button to the dialog and make it sensitive

References convertMnemonics(), and UT_return_val_if_fail.

void abiDestroyWidget ( GtkWidget * me )

Calls gtk_widget_destroy on if is non-null and GTK_IS_WIDGET(me)

GtkWidget* abiDialogNew	(	const char *	role,
		gboolean	resizable
	)

Create a new GtkDialog

GtkWidget* abiDialogNew	(	const char *	role,
		gboolean	resizable,
		const char *	title,
			...
	)

Create a new GtkDialog with this title

References abiDialogNew(), and UT_std_string_vprintf().

void abiDialogSetTitle	(	GtkWidget *	dlg,
		const char *	title,
			...
	)

GtkWidget* abiGtkMenuFromCStrVector	(	const UT_GenericVector< const char * > &	vec,
		GCallback	cb,
		gpointer	data
	)

Returns a GtkMenu with items having label fetched from UTF-8 CStr from UT_Vector. All menu item will have the index of the item stored in its user-data

References UT_GenericVector< T >::getItemCount().

gint abiRunModalDialog	(	GtkDialog *	me,
		XAP_Frame *	pFrame,
		XAP_Dialog *	pDlg,
		gint	defaultResponse,
		bool	destroyDialog,
		AtkRole	role
	)

Runs the dialog as a modal dialog 1) Connect focus to toplevel frame 2) Centers dialog over toplevel window 3) Connects F1 to help system 4) Makes dialog modal 5) Sets the default button to defaultResponse, sets ESC to close 6) Returns value of gtk_dialog_run(me) 7) If is true, destroys the dialog, else you have to call abiDestroyWidget()

References abiRunModalDialog(), abiSetupModalDialog(), and XAP_Dialog::maybeReallowPopupPreviewBubbles().

gint abiRunModalDialog	(	GtkDialog *	me,
		bool	destroyDialog,
		AtkRole	role = `ATK_ROLE_DIALOG`
	)

References abiDestroyWidget().

void abiSetActivateOnWidgetToActivateButton	(	GtkWidget *	source,
		GtkWidget *	button
	)

When the source widget gets the activate signal, sent activate to the button.

This allows GtkEntry widgets to explicitly close the dialog with the OK button when the user presses return while leaving the default dialog action to be CANCEL.

References activate_button().

Referenced by AP_UnixDialog_MarkRevisions::constructWindow().

void abiSetupModalDialog	(	GtkDialog *	me,
		XAP_Frame *	pFrame,
		XAP_Dialog *	pDlg,
		gint	dfl_id
	)

References centerDialog(), connectFocus(), XAP_Frame::getFrameImpl(), XAP_UnixFrameImpl::getTopLevelWindow(), modal_keypress_cb(), and sAddHelpButton().

Referenced by abiRunModalDialog(), AP_UnixDialog_Styles::modifyRunModal(), XAP_UnixDialog_FileOpenSaveAs::runModal(), AP_UnixDialog_Styles::runModal(), and AP_UnixDialog_Spell::runModal().

void abiSetupModelessDialog	(	GtkDialog *	me,
		XAP_Frame *	pFrame,
		XAP_Dialog *	pDlg,
		gint	defaultResponse,
		bool	abi_modeless,
		AtkRole
	)

Sets up the dialog as a modeless dialog 1) Connect focus to toplevel frame 2) Centers dialog over toplevel window 3) Makes the App remember this modeless dialog 4) Connects F1 to help system 5) Makes dialog non-modal (modeless)

6) Sets the default button to defaultResponse, sets ESC to close

References centerDialog(), connectFocusModeless(), XAP_App::getApp(), XAP_Dialog::getDialogId(), XAP_Frame::getFrameImpl(), XAP_UnixFrameImpl::getTopLevelWindow(), XAP_Dialog::maybeClosePopupPreviewBubbles(), nonmodal_keypress_cb(), XAP_App::rememberModelessId(), and sAddHelpButton().

void centerDialog	(	GtkWidget *	parent,
		GtkWidget *	child,
		bool	set_transient_for
	)

Centers a dialog, makes it transient, sets up the right window icon

References UT_return_if_fail, and xxx_UT_DEBUGMSG.

Referenced by abiSetupModalDialog(), abiSetupModelessDialog(), GDict_dlg_create(), and XAP_UnixDialog_FileOpenSaveAs::runModal().

void connectFocus	(	GtkWidget *	widget,
		const XAP_Frame *	frame
	)

References destroy_event(), focus_in_event(), and focus_out_event().

Referenced by abiSetupModalDialog(), and XAP_UnixDialog_ClipArt::runModal().

void connectFocusModeless	(	GtkWidget *	widget,
		const XAP_App *	pApp
	)

References destroy_event(), focus_in_event_Modeless(), and focus_out_event_Modeless().

Referenced by abiSetupModelessDialog().

void connectFocusModelessOther	(	GtkWidget *	widget,
		const XAP_App *	pApp,
		std::pointer_to_unary_function< int, gboolean > *	other_function
	)

References focus_in_event_ModelessOther(), and focus_out_event_Modeless().

Referenced by AP_UnixDialog_Lists::runModeless().

std::string& convertMnemonics ( std::string & s )

void void convertMnemonics ( gchar * s )

References UT_return_if_fail.

Referenced by abiAddButton(), AbiGOComponent_Create(), localizeButtonMarkup(), localizeButtonUnderline(), localizeLabelUnderline(), XAP_UnixDialog_MessageBox::runModal(), XAP_UnixDialog_FileOpenSaveAs::runModal(), sAddHelpButton(), and AP_RDFSemanticItemGTKInjected< AP_RDFContact >::showEditorWindow().

GdkWindow* getRootWindow ( GtkWidget * widget )

References UT_return_val_if_fail.

bool isTransientWindow	(	GtkWindow *	window,
		GtkWindow *	parent
	)

Referenced by AP_UnixFrame::_setViewFocus().

void localizeButton	(	GtkWidget *	widget,
		const XAP_StringSet *	pSS,
		XAP_String_Id	id
	)

Localizes a button given the string id

References FREEP, gchar, XAP_StringSet::getValueUTF8(), s, and UT_XML_cloneNoAmpersands().

void localizeButtonMarkup	(	GtkWidget *	widget,
		const XAP_StringSet *	pSS,
		XAP_String_Id	id
	)

Localizes a button given the string id It formats its label using the current button label as a format string. It is assumed to be something like "%s". Note that in addition to doing markup, ampersands will be converted to underscores/mnemonic since this makes sense for buttons

References convertMnemonics(), FREEP, gchar, XAP_StringSet::getValueUTF8(), s, UT_ASSERT, and UT_std_string_sprintf().

Referenced by AP_UnixDialog_FormatTOC::_constructWindow(), and AP_UnixDialog_Options::_constructWindowContents().

void localizeButtonUnderline	(	GtkWidget *	widget,
		const XAP_StringSet *	pSS,
		XAP_String_Id	id
	)

Localizes a button given the string id Ampersands will be converted to underscores/mnemonics

References convertMnemonics(), FREEP, gchar, XAP_StringSet::getValueUTF8(), s, and UT_ASSERT.

void localizeLabel	(	GtkWidget *	widget,
		const XAP_StringSet *	pSS,
		XAP_String_Id	id
	)

Localizes a label given the string id

References FREEP, gchar, XAP_StringSet::getValueUTF8(), s, and UT_XML_cloneNoAmpersands().

void localizeLabelMarkup	(	GtkWidget *	widget,
		const XAP_StringSet *	pSS,
		XAP_String_Id	id
	)

Localizes the label of a widget given the string id It formats the label using the current label of the widget as a format string. The current label is assumed to be something like "%s".

References FREEP, gchar, XAP_StringSet::getValueUTF8(), s, UT_std_string_sprintf(), and UT_XML_cloneNoAmpersands().

void localizeLabelUnderline	(	GtkWidget *	widget,
		const XAP_StringSet *	pSS,
		XAP_String_Id	id
	)

Localizes the label of a widget given the string id Ampersands will be converted to underscores/mnemonics

References convertMnemonics(), FREEP, gchar, XAP_StringSet::getValueUTF8(), s, and UT_ASSERT.

Referenced by AP_UnixDialog_Spell::_constructWindow(), AP_UnixDialog_FormatTOC::_constructWindow(), and AP_UnixDialog_Options::_constructWindowContents().

void localizeMenuItem	(	GtkWidget *	widget,
		const XAP_StringSet *	pSS,
		XAP_String_Id	id
	)

Localizes the label of a Menu Item widget given the string id

References FREEP, gchar, XAP_StringSet::getValueUTF8(), s, and UT_XML_cloneConvAmpersands().

Referenced by AP_UnixDialog_RDFEditor::_constructWindow().

void messageBoxOK ( const char * message )

This is a small message box for startup warnings and/or errors. Please do NOT use this for normal system execution user messages; use the XAP_UnixDialog_MessageBox class for that. We can't use that here because there is no parent frame, etc.

Referenced by AP_UnixDialog_Styles::_populateModify(), and AP_UnixDialog_Styles::new_styleName().

GtkBuilder* newDialogBuilder ( const char * name )

load a GtkBuilder for a dialog using the standard path.

Parameters:

name

the filename of the dialog (no path)

Returns:: the GtkBuilder or NULL. The returned object my be freed as usual.

References XAP_App::getApp(), and UT_ASSERT.

void setLabelMarkup	(	GtkWidget *	widget,
		const gchar *	str
	)

Sets the label of "widget" to "str". It formats the label using the current label of the widget as a format string. The current label is assumed to be something like "%s".

References UT_std_string_sprintf().

Referenced by XAP_UnixDialog_ListDocuments::_constructWindow(), and XAP_UnixDialog_History::_populateWindowData().

xap_UnixDialogHelper.h File Reference

Defines

Functions

Define Documentation

Function Documentation