nvdialog_about_dialog.h File Reference

#include "../nvdialog_image.h"
#include "../nvdialog_platform.h"

Go to the source code of this file.

Typedefs
typedef struct _NvdAboutDialog	NvdAboutDialog
	An opaque handle to a dialog box created from nvd_about_dialog_new.

Functions
NVD_API NvdAboutDialog *	nvd_about_dialog_new (const char *name, const char *description, const char *logo)
	Shows an 'About application' dialog box.
NVD_API void	nvd_about_dialog_set_license_link (NvdAboutDialog *dialog, const char *license_link, const char *txt)
	Sets a hyperlink to the application's license (Preferably a link.)
NVD_API void	nvd_about_dialog_set_version (NvdAboutDialog *dialog, const char *version)
	Adds a version text to the dialog given.
NVD_API void	nvd_show_about_dialog (NvdAboutDialog *dialog)
	Shows the About dialog given to the user.
NVD_API void *	nvd_about_dialog_get_raw (NvdAboutDialog *dialog)
	Returns the raw object behind the dialog.
NVD_API void	nvd_dialog_set_icon (NvdAboutDialog *dialog, NvdImage *image)
	Sets the dialog's icon to display.

Typedef Documentation

NvdAboutDialog

typedef struct _NvdAboutDialog NvdAboutDialog

An opaque handle to a dialog box created from nvd_about_dialog_new.

Function Documentation

nvd_about_dialog_get_raw()

NVD_API void * nvd_about_dialog_get_raw

(

NvdAboutDialog *

dialog

)

Returns the raw object behind the dialog.

Parameters

dialog

The dialog to retrieve the object from.

Returns

void* The raw toolkit-created object.

nvd_about_dialog_new()

NVD_API NvdAboutDialog * nvd_about_dialog_new	(	const char *	name,
		const char *	description,
		const char *	logo
	)

Shows an 'About application' dialog box.

This function displays a dialog box similar to 'About' menus in other applications. It will display the application name, a brief description of the application, the logo (If specified)

Parameters

name	Your application name.
description	A short description of the application, describing what it does.
logo	Nullable value that can specify a filename to load as the application logo.

Note

This function does not use GtkAboutDialog on Unix.

Returns

NULL on failure, otherwise a handle to a heap allocated object containing the actual dialog.

nvd_about_dialog_set_license_link()

NVD_API void nvd_about_dialog_set_license_link	(	NvdAboutDialog *	dialog,
		const char *	license_link,
		const char *	txt
	)

Sets a hyperlink to the application's license (Preferably a link.)

Parameters

dialog	The dialog to set the hyperlink to.
license_link	The link that points to your license.
txt	A text string to set as the link's text. Can be NULL if the link can be used as the text too.

Warning

This function has no effect on Windows.

nvd_about_dialog_set_version()

NVD_API void nvd_about_dialog_set_version	(	NvdAboutDialog *	dialog,
		const char *	version
	)

Adds a version text to the dialog given.

Parameters

dialog	The dialog to set the version to.
version	A string to represent the version of your application.

nvd_dialog_set_icon()

NVD_API void nvd_dialog_set_icon	(	NvdAboutDialog *	dialog,
		NvdImage *	image
	)

Sets the dialog's icon to display.

Parameters

dialog	The dialog to set the icon to.
image	The image to display as the dialog's icon, returned from nvd_create_image

Since

v0.9.0

nvd_show_about_dialog()

NVD_API void nvd_show_about_dialog

(

NvdAboutDialog *

dialog

)

Shows the About dialog given to the user.

Parameters

dialog

The dialog to show.