GNOME.org
 

[evolution] EMailFormatterExtension: Convert get_description() to a string field.

commit d9699159f010c612deca650c6ee336763d908954
Author: Matthew Barnes <mbarnes redhat com>
Date:   Fri Dec 7 10:31:18 2012 -0500

    EMailFormatterExtension: Convert get_description() to a string field.
    
    Of the formatter extensions that provide a description, they all use a
    static string.  So we don't need an instance of the extension to obtain
    its description.  Just make it a string field in the class structure.

 em-format/e-mail-formatter-attachment-bar.c        |    7 ------
 em-format/e-mail-formatter-attachment.c            |    8 +------
 em-format/e-mail-formatter-error.c                 |    7 ------
 em-format/e-mail-formatter-extension.c             |   21 --------------------
 em-format/e-mail-formatter-extension.h             |    8 ++----
 em-format/e-mail-formatter-headers.c               |    7 ------
 em-format/e-mail-formatter-image.c                 |    8 +------
 em-format/e-mail-formatter-message-rfc822.c        |    8 +------
 em-format/e-mail-formatter-print-headers.c         |    7 ------
 em-format/e-mail-formatter-quote-attachment.c      |    7 ------
 em-format/e-mail-formatter-quote-headers.c         |    7 ------
 em-format/e-mail-formatter-quote-message-rfc822.c  |    7 ------
 em-format/e-mail-formatter-quote-text-enriched.c   |    8 +------
 em-format/e-mail-formatter-quote-text-html.c       |    8 +------
 em-format/e-mail-formatter-quote-text-plain.c      |    8 +------
 em-format/e-mail-formatter-secure-button.c         |    7 ------
 em-format/e-mail-formatter-source.c                |    8 +------
 em-format/e-mail-formatter-text-enriched.c         |    8 +------
 em-format/e-mail-formatter-text-html.c             |    8 +------
 em-format/e-mail-formatter-text-plain.c            |    8 +------
 .../audio-inline/e-mail-formatter-audio-inline.c   |    8 +------
 modules/itip-formatter/e-mail-formatter-itip.c     |    8 +------
 .../e-mail-formatter-text-highlight.c              |    8 +------
 .../vcard-inline/e-mail-formatter-vcard-inline.c   |    8 +------
 24 files changed, 17 insertions(+), 180 deletions(-)
---
diff --git a/em-format/e-mail-formatter-attachment-bar.c b/em-format/e-mail-formatter-attachment-bar.c
index c9c9ef1..0404d9c 100644
--- a/em-format/e-mail-formatter-attachment-bar.c
+++ b/em-format/e-mail-formatter-attachment-bar.c
@@ -98,19 +98,12 @@ emfe_attachment_bar_get_widget (EMailFormatterExtension *extension,
 	return widget;
 }
 
-static const gchar *
-emfe_attachment_bar_get_description (EMailFormatterExtension *extension)
-{
-	return NULL;
-}
-
 static void
 e_mail_formatter_attachment_bar_class_init (EMailFormatterExtensionClass *class)
 {
 	class->mime_types = formatter_mime_types;
 	class->format = emfe_attachment_bar_format;
 	class->get_widget = emfe_attachment_bar_get_widget;
-	class->get_description = emfe_attachment_bar_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-attachment.c b/em-format/e-mail-formatter-attachment.c
index 5fedf95..fa0e585 100644
--- a/em-format/e-mail-formatter-attachment.c
+++ b/em-format/e-mail-formatter-attachment.c
@@ -362,20 +362,14 @@ emfe_attachment_get_widget (EMailFormatterExtension *extension,
 	return widget;
 }
 
-static const gchar *
-emfe_attachment_get_description (EMailFormatterExtension *extension)
-{
-	return _("Display as attachment");
-}
-
 static void
 e_mail_formatter_attachment_class_init (EMailFormatterExtensionClass *class)
 {
 	class->display_name = _("Attachment");
+	class->description =  _("Display as attachment");
 	class->mime_types = formatter_mime_types;
 	class->format = emfe_attachment_format;
 	class->get_widget = emfe_attachment_get_widget;
-	class->get_description = emfe_attachment_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-error.c b/em-format/e-mail-formatter-error.c
index 22f661b..f3bf6f6 100644
--- a/em-format/e-mail-formatter-error.c
+++ b/em-format/e-mail-formatter-error.c
@@ -104,18 +104,11 @@ emfe_error_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emfe_error_get_description (EMailFormatterExtension *extension)
-{
-	return NULL;
-}
-
 static void
 e_mail_formatter_error_class_init (EMailFormatterExtensionClass *class)
 {
 	class->mime_types = formatter_mime_types;
 	class->format = emfe_error_format;
-	class->get_description = emfe_error_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-extension.c b/em-format/e-mail-formatter-extension.c
index 01764a7..9390d77 100644
--- a/em-format/e-mail-formatter-extension.c
+++ b/em-format/e-mail-formatter-extension.c
@@ -138,24 +138,3 @@ e_mail_formatter_extension_get_widget (EMailFormatterExtension *extension,
 	return widget;
 }
 
-/**
- * e_mail_formatter_extension_get_description:
- * @extension: an #EMailFormatterExtension
- *
- * A virtual function reimplemented in all formatter extensions. It returns a
- * longer description of capabilities of the extension.
- *
- * Returns: A (localized) string with description of the extension.
- */
-const gchar *
-e_mail_formatter_extension_get_description (EMailFormatterExtension *extension)
-{
-	EMailFormatterExtensionClass *class;
-
-	g_return_val_if_fail (E_IS_MAIL_FORMATTER_EXTENSION (extension), NULL);
-
-	class = E_MAIL_FORMATTER_EXTENSION_GET_CLASS (extension);
-	g_return_val_if_fail (class->get_description != NULL, NULL);
-
-	return class->get_description (extension);
-}
diff --git a/em-format/e-mail-formatter-extension.h b/em-format/e-mail-formatter-extension.h
index e03932b..bdae859 100644
--- a/em-format/e-mail-formatter-extension.h
+++ b/em-format/e-mail-formatter-extension.h
@@ -69,6 +69,9 @@ struct _EMailFormatterExtensionClass {
 	/* This is a short name for the extension (optional). */
 	const gchar *display_name;
 
+	/* This is a longer description of the extension (optional). */
+	const gchar *description;
+
 	/* This is a NULL-terminated array of supported MIME types.
 	 * The MIME types can be exact (e.g. "text/plain") or use a
 	 * wildcard (e.g. "text/ *"). */
@@ -84,9 +87,6 @@ struct _EMailFormatterExtensionClass {
 					 EMailPartList *context,
 					 EMailPart *part,
 					 GHashTable *params);
-	const gchar *	(*get_description)
-					(EMailFormatterExtension *extension);
-
 };
 
 GType		e_mail_formatter_extension_get_type
@@ -105,8 +105,6 @@ GtkWidget *	e_mail_formatter_extension_get_widget
 						 EMailPartList *context,
 						 EMailPart *part,
 						 GHashTable *params);
-const gchar *	e_mail_formatter_extension_get_description
-						(EMailFormatterExtension *extension);
 
 G_END_DECLS
 
diff --git a/em-format/e-mail-formatter-headers.c b/em-format/e-mail-formatter-headers.c
index 8c1a46a..8759ece 100644
--- a/em-format/e-mail-formatter-headers.c
+++ b/em-format/e-mail-formatter-headers.c
@@ -559,18 +559,11 @@ emfe_headers_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emfe_headers_get_description (EMailFormatterExtension *extension)
-{
-	return NULL;
-}
-
 static void
 e_mail_formatter_headers_class_init (EMailFormatterExtensionClass *class)
 {
 	class->mime_types = formatter_mime_types;
 	class->format = emfe_headers_format;
-	class->get_description = emfe_headers_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-image.c b/em-format/e-mail-formatter-image.c
index 63f17b0..f06bff1 100644
--- a/em-format/e-mail-formatter-image.c
+++ b/em-format/e-mail-formatter-image.c
@@ -139,19 +139,13 @@ emfe_image_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emfe_image_get_description (EMailFormatterExtension *extension)
-{
-	return _("Display part as an image");
-}
-
 static void
 e_mail_formatter_image_class_init (EMailFormatterExtensionClass *class)
 {
 	class->display_name = _("Regular Image");
+	class->description = _("Display part as an image");
 	class->mime_types = formatter_mime_types;
 	class->format = emfe_image_format;
-	class->get_description = emfe_image_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-message-rfc822.c b/em-format/e-mail-formatter-message-rfc822.c
index 893344e..41b89f4 100644
--- a/em-format/e-mail-formatter-message-rfc822.c
+++ b/em-format/e-mail-formatter-message-rfc822.c
@@ -230,19 +230,13 @@ emfe_message_rfc822_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emfe_message_rfc822_get_description (EMailFormatterExtension *extension)
-{
-	return _("Format part as an RFC822 message");
-}
-
 static void
 e_mail_formatter_message_rfc822_class_init (EMailFormatterExtensionClass *class)
 {
 	class->display_name = _("RFC822 message");
+	class->description = _("Format part as an RFC822 message");
 	class->mime_types = formatter_mime_types;
 	class->format = emfe_message_rfc822_format;
-	class->get_description = emfe_message_rfc822_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-print-headers.c b/em-format/e-mail-formatter-print-headers.c
index 956338f..8f1745b 100644
--- a/em-format/e-mail-formatter-print-headers.c
+++ b/em-format/e-mail-formatter-print-headers.c
@@ -206,18 +206,11 @@ emfpe_headers_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emfpe_headers_get_description (EMailFormatterExtension *extension)
-{
-	return NULL;
-}
-
 static void
 e_mail_formatter_print_headers_class_init (EMailFormatterExtensionClass *class)
 {
 	class->mime_types = formatter_mime_types;
 	class->format = emfpe_headers_format;
-	class->get_description = emfpe_headers_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-quote-attachment.c b/em-format/e-mail-formatter-quote-attachment.c
index 03a2961..d442236 100644
--- a/em-format/e-mail-formatter-quote-attachment.c
+++ b/em-format/e-mail-formatter-quote-attachment.c
@@ -107,18 +107,11 @@ emfqe_attachment_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emfqe_attachment_get_description (EMailFormatterExtension *extension)
-{
-	return NULL;
-}
-
 static void
 e_mail_formatter_quote_attachment_class_init (EMailFormatterExtensionClass *class)
 {
 	class->mime_types = formatter_mime_types;
 	class->format = emfqe_attachment_format;
-	class->get_description = emfqe_attachment_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-quote-headers.c b/em-format/e-mail-formatter-quote-headers.c
index 3b1a74b..b98f179 100644
--- a/em-format/e-mail-formatter-quote-headers.c
+++ b/em-format/e-mail-formatter-quote-headers.c
@@ -232,18 +232,11 @@ emqfe_headers_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emqfe_headers_get_description (EMailFormatterExtension *extension)
-{
-	return NULL;
-}
-
 static void
 e_mail_formatter_quote_headers_class_init (EMailFormatterExtensionClass *class)
 {
 	class->mime_types = formatter_mime_types;
 	class->format = emqfe_headers_format;
-	class->get_description = emqfe_headers_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-quote-message-rfc822.c b/em-format/e-mail-formatter-quote-message-rfc822.c
index a26b735..d235788 100644
--- a/em-format/e-mail-formatter-quote-message-rfc822.c
+++ b/em-format/e-mail-formatter-quote-message-rfc822.c
@@ -136,18 +136,11 @@ emfqe_message_rfc822_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emfqe_message_rfc822_get_description (EMailFormatterExtension *extension)
-{
-	return NULL;
-}
-
 static void
 e_mail_formatter_quote_message_rfc822_class_init (EMailFormatterExtensionClass *class)
 {
 	class->mime_types = formatter_mime_types;
 	class->format = emfqe_message_rfc822_format;
-	class->get_description = emfqe_message_rfc822_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-quote-text-enriched.c b/em-format/e-mail-formatter-quote-text-enriched.c
index b397b18..05ae6e0 100644
--- a/em-format/e-mail-formatter-quote-text-enriched.c
+++ b/em-format/e-mail-formatter-quote-text-enriched.c
@@ -81,19 +81,13 @@ emqfe_text_enriched_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emqfe_text_enriched_get_description (EMailFormatterExtension *extension)
-{
-	return _("Display part as enriched text");
-}
-
 static void
 e_mail_formatter_quote_text_enriched_class_init (EMailFormatterExtensionClass *class)
 {
 	class->display_name = _("Richtext");
+	class->description = _("Display part as enriched text");
 	class->mime_types = formatter_mime_types;
 	class->format = emqfe_text_enriched_format;
-	class->get_description = emqfe_text_enriched_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-quote-text-html.c b/em-format/e-mail-formatter-quote-text-html.c
index 0031507..dc98d99 100644
--- a/em-format/e-mail-formatter-quote-text-html.c
+++ b/em-format/e-mail-formatter-quote-text-html.c
@@ -84,19 +84,13 @@ emqfe_text_html_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emqfe_text_html_get_description (EMailFormatterExtension *extension)
-{
-	return _("Format part as HTML");
-}
-
 static void
 e_mail_formatter_quote_text_html_class_init (EMailFormatterExtensionClass *class)
 {
 	class->display_name = _("HTML");
+	class->description = _("Format part as HTML");
 	class->mime_types = formatter_mime_types;
 	class->format = emqfe_text_html_format;
-	class->get_description = emqfe_text_html_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-quote-text-plain.c b/em-format/e-mail-formatter-quote-text-plain.c
index 9ac12b3..8c7e369 100644
--- a/em-format/e-mail-formatter-quote-text-plain.c
+++ b/em-format/e-mail-formatter-quote-text-plain.c
@@ -103,19 +103,13 @@ emqfe_text_plain_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emqfe_text_plain_get_description (EMailFormatterExtension *extension)
-{
-	return _("Format part as plain text");
-}
-
 static void
 e_mail_formatter_quote_text_plain_class_init (EMailFormatterExtensionClass *class)
 {
 	class->display_name = _("Plain Text");
+	class->description = _("Format part as plain text");
 	class->mime_types = formatter_mime_types;
 	class->format = emqfe_text_plain_format;
-	class->get_description = emqfe_text_plain_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-secure-button.c b/em-format/e-mail-formatter-secure-button.c
index a900fc9..164cb19 100644
--- a/em-format/e-mail-formatter-secure-button.c
+++ b/em-format/e-mail-formatter-secure-button.c
@@ -459,19 +459,12 @@ emfe_secure_button_get_widget (EMailFormatterExtension *extension,
 	return grid;
 }
 
-static const gchar *
-emfe_secure_button_get_description (EMailFormatterExtension *extension)
-{
-	return NULL;
-}
-
 static void
 e_mail_formatter_secure_button_class_init (EMailFormatterExtensionClass *class)
 {
 	class->mime_types = formatter_mime_types;
 	class->format = emfe_secure_button_format;
 	class->get_widget = emfe_secure_button_get_widget;
-	class->get_description = emfe_secure_button_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-source.c b/em-format/e-mail-formatter-source.c
index aec6ea2..26e9d92 100644
--- a/em-format/e-mail-formatter-source.c
+++ b/em-format/e-mail-formatter-source.c
@@ -121,19 +121,13 @@ emfe_source_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emfe_source_get_description (EMailFormatterExtension *extension)
-{
-	return _("Display source of a MIME part");
-}
-
 static void
 e_mail_formatter_source_class_init (EMailFormatterExtensionClass *class)
 {
 	class->display_name = _("Source");
+	class->description = _("Display source of a MIME part");
 	class->mime_types = formatter_mime_types;
 	class->format = emfe_source_format;
-	class->get_description = emfe_source_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-text-enriched.c b/em-format/e-mail-formatter-text-enriched.c
index e88d96b..ce2769d 100644
--- a/em-format/e-mail-formatter-text-enriched.c
+++ b/em-format/e-mail-formatter-text-enriched.c
@@ -97,19 +97,13 @@ emfe_text_enriched_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emfe_text_enriched_get_description (EMailFormatterExtension *extension)
-{
-	return _("Display part as enriched text");
-}
-
 static void
 e_mail_formatter_text_enriched_class_init (EMailFormatterExtensionClass *class)
 {
 	class->display_name = _("Richtext");
+	class->description = _("Display part as enriched text");
 	class->mime_types = formatter_mime_types;
 	class->format = emfe_text_enriched_format;
-	class->get_description = emfe_text_enriched_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-text-html.c b/em-format/e-mail-formatter-text-html.c
index 8b7453f..c3b190f 100644
--- a/em-format/e-mail-formatter-text-html.c
+++ b/em-format/e-mail-formatter-text-html.c
@@ -336,19 +336,13 @@ emfe_text_html_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emfe_text_html_get_description (EMailFormatterExtension *extension)
-{
-	return _("Format part as HTML");
-}
-
 static void
 e_mail_formatter_text_html_class_init (EMailFormatterExtensionClass *class)
 {
 	class->display_name = _("HTML");
+	class->description = _("Format part as HTML");
 	class->mime_types = formatter_mime_types;
 	class->format = emfe_text_html_format;
-	class->get_description = emfe_text_html_get_description;
 }
 
 static void
diff --git a/em-format/e-mail-formatter-text-plain.c b/em-format/e-mail-formatter-text-plain.c
index 922a7c4..9a3b31a 100644
--- a/em-format/e-mail-formatter-text-plain.c
+++ b/em-format/e-mail-formatter-text-plain.c
@@ -171,19 +171,13 @@ emfe_text_plain_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emfe_text_plain_get_description (EMailFormatterExtension *extension)
-{
-	return _("Format part as plain text");
-}
-
 static void
 e_mail_formatter_text_plain_class_init (EMailFormatterExtensionClass *class)
 {
 	class->display_name = _("Plain Text");
+	class->description = _("Format part as plain text");
 	class->mime_types = formatter_mime_types;
 	class->format = emfe_text_plain_format;
-	class->get_description = emfe_text_plain_get_description;
 }
 
 static void
diff --git a/modules/audio-inline/e-mail-formatter-audio-inline.c b/modules/audio-inline/e-mail-formatter-audio-inline.c
index ed56307..4520e37 100644
--- a/modules/audio-inline/e-mail-formatter-audio-inline.c
+++ b/modules/audio-inline/e-mail-formatter-audio-inline.c
@@ -311,20 +311,14 @@ emfe_audio_inline_get_widget (EMailFormatterExtension *extension,
 	return box;
 }
 
-static const gchar *
-emfe_audio_inline_get_description (EMailFormatterExtension *extension)
-{
-	return _("Play the attachment in embedded audio player");
-}
-
 static void
 e_mail_formatter_audio_inline_class_init (EMailFormatterExtensionClass *class)
 {
 	class->display_name = _("Audio Player");
+	class->description = _("Play the attachment in embedded audio player");
 	class->mime_types = formatter_mime_types;
 	class->format = emfe_audio_inline_format;
 	class->get_widget = emfe_audio_inline_get_widget;
-	class->get_description = emfe_audio_inline_get_description;
 }
 
 static void
diff --git a/modules/itip-formatter/e-mail-formatter-itip.c b/modules/itip-formatter/e-mail-formatter-itip.c
index 03101fb..86132f4 100644
--- a/modules/itip-formatter/e-mail-formatter-itip.c
+++ b/modules/itip-formatter/e-mail-formatter-itip.c
@@ -136,19 +136,13 @@ emfe_itip_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emfe_itip_get_description (EMailFormatterExtension *extension)
-{
-	return _("Display part as an invitation");
-}
-
 static void
 e_mail_formatter_itip_class_init (EMailFormatterExtensionClass *class)
 {
 	class->display_name = _("ITIP");
+	class->description = _("Display part as an invitation");
 	class->mime_types = formatter_mime_types;
 	class->format = emfe_itip_format;
-	class->get_description = emfe_itip_get_description;
 }
 
 static void
diff --git a/modules/text-highlight/e-mail-formatter-text-highlight.c b/modules/text-highlight/e-mail-formatter-text-highlight.c
index 8d44135..fc5ca1d 100644
--- a/modules/text-highlight/e-mail-formatter-text-highlight.c
+++ b/modules/text-highlight/e-mail-formatter-text-highlight.c
@@ -356,19 +356,13 @@ emfe_text_highlight_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emfe_text_highlight_get_description (EMailFormatterExtension *extension)
-{
-	return _("Syntax highlighting of mail parts");
-}
-
 static void
 e_mail_formatter_text_highlight_class_init (EMailFormatterExtensionClass *class)
 {
 	class->display_name = _("Text Highlight");
+	class->description = _("Syntax highlighting of mail parts");
 	class->mime_types = get_mime_types ();
 	class->format = emfe_text_highlight_format;
-	class->get_description = emfe_text_highlight_get_description;
 }
 
 static void
diff --git a/modules/vcard-inline/e-mail-formatter-vcard-inline.c b/modules/vcard-inline/e-mail-formatter-vcard-inline.c
index a5240db..873d9c7 100644
--- a/modules/vcard-inline/e-mail-formatter-vcard-inline.c
+++ b/modules/vcard-inline/e-mail-formatter-vcard-inline.c
@@ -194,19 +194,13 @@ emfe_vcard_inline_format (EMailFormatterExtension *extension,
 	return TRUE;
 }
 
-static const gchar *
-emfe_vcard_inline_get_description (EMailFormatterExtension *extension)
-{
-	return _("Display the part as an addressbook contact");
-}
-
 static void
 e_mail_formatter_vcard_inline_class_init (EMailFormatterExtensionClass *class)
 {
 	class->display_name = _("Addressbook Contact");
+	class->description = _("Display the part as an addressbook contact");
 	class->mime_types = formatter_mime_types;
 	class->format = emfe_vcard_inline_format;
-	class->get_description = emfe_vcard_inline_get_description;
 }
 
 static void
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]