GNOME.org
 

[evolution-data-server] Rename "name" property of CamelFolder to "display-name".

commit 83ef424827fc88a643116e91d6cbbfb04a3a14e4
Author: Matthew Barnes <mbarnes redhat com>
Date:   Sat May 7 10:49:05 2011 -0400

    Rename "name" property of CamelFolder to "display-name".
    
    To correspond with CamelFolderInfo changes.

 camel/camel-folder.c                        |  102 +++++++++++++-------------
 camel/camel-folder.h                        |    6 +-
 camel/camel-vee-folder.c                    |    2 +-
 camel/camel-vee-store.c                     |    8 +--
 camel/providers/imap/camel-imap-folder.c    |    6 +-
 camel/providers/imapx/camel-imapx-server.c  |    6 +-
 docs/reference/camel/camel-sections.txt     |    4 +-
 docs/reference/camel/tmpl/camel-folder.sgml |   16 ++--
 docs/reference/camel/tmpl/camel-unused.sgml |   22 ++++++
 9 files changed, 96 insertions(+), 76 deletions(-)
---
diff --git a/camel/camel-folder.c b/camel/camel-folder.c
index 64267d3..ab405fa 100644
--- a/camel/camel-folder.c
+++ b/camel/camel-folder.c
@@ -59,8 +59,8 @@ struct _CamelFolderPrivate {
 
 	CamelStore *parent_store;
 
-	gchar *name;
 	gchar *full_name;
+	gchar *display_name;
 	gchar *description;
 };
 
@@ -102,8 +102,8 @@ struct _FolderFilterData {
 enum {
 	PROP_0,
 	PROP_DESCRIPTION,
+	PROP_DISPLAY_NAME,
 	PROP_FULL_NAME,
-	PROP_NAME,
 	PROP_PARENT_STORE
 };
 
@@ -422,14 +422,14 @@ folder_set_property (GObject *object,
 				g_value_get_string (value));
 			return;
 
-		case PROP_FULL_NAME:
-			camel_folder_set_full_name (
+		case PROP_DISPLAY_NAME:
+			camel_folder_set_display_name (
 				CAMEL_FOLDER (object),
 				g_value_get_string (value));
 			return;
 
-		case PROP_NAME:
-			camel_folder_set_name (
+		case PROP_FULL_NAME:
+			camel_folder_set_full_name (
 				CAMEL_FOLDER (object),
 				g_value_get_string (value));
 			return;
@@ -457,15 +457,15 @@ folder_get_property (GObject *object,
 				CAMEL_FOLDER (object)));
 			return;
 
-		case PROP_FULL_NAME:
+		case PROP_DISPLAY_NAME:
 			g_value_set_string (
-				value, camel_folder_get_full_name (
+				value, camel_folder_get_display_name (
 				CAMEL_FOLDER (object)));
 			return;
 
-		case PROP_NAME:
+		case PROP_FULL_NAME:
 			g_value_set_string (
-				value, camel_folder_get_name (
+				value, camel_folder_get_full_name (
 				CAMEL_FOLDER (object)));
 			return;
 
@@ -508,8 +508,8 @@ folder_finalize (GObject *object)
 
 	priv = CAMEL_FOLDER (object)->priv;
 
-	g_free (priv->name);
 	g_free (priv->full_name);
+	g_free (priv->display_name);
 	g_free (priv->description);
 
 	camel_folder_change_info_free (priv->changed_frozen);
@@ -780,7 +780,7 @@ folder_rename (CamelFolder *folder,
 	camel_folder_set_full_name (folder, new);
 
 	tmp = strrchr (new, '/');
-	camel_folder_set_name (folder, (tmp != NULL) ? tmp + 1 : new);
+	camel_folder_set_display_name (folder, (tmp != NULL) ? tmp + 1 : new);
 }
 
 static void
@@ -1532,33 +1532,33 @@ camel_folder_class_init (CamelFolderClass *class)
 			G_PARAM_CONSTRUCT));
 
 	/**
-	 * CamelFolder:full-name
+	 * CamelFolder:display-name
 	 *
-	 * The folder's fully qualified name.
+	 * The folder's display name.
 	 **/
 	g_object_class_install_property (
 		object_class,
-		PROP_FULL_NAME,
+		PROP_DISPLAY_NAME,
 		g_param_spec_string (
-			"full-name",
-			"Full Name",
-			"The folder's fully qualified name",
+			"display-name",
+			"Display Name",
+			"The folder's display name",
 			NULL,
 			G_PARAM_READWRITE |
 			G_PARAM_CONSTRUCT));
 
 	/**
-	 * CamelFolder:name
+	 * CamelFolder:full-name
 	 *
-	 * The folder's short name.
+	 * The folder's fully qualified name.
 	 **/
 	g_object_class_install_property (
 		object_class,
-		PROP_NAME,
+		PROP_FULL_NAME,
 		g_param_spec_string (
-			"name",
-			"Name",
-			"The folder's short name",
+			"full-name",
+			"Full Name",
+			"The folder's fully qualified name",
 			NULL,
 			G_PARAM_READWRITE |
 			G_PARAM_CONSTRUCT));
@@ -1691,78 +1691,78 @@ camel_folder_get_filename (CamelFolder *folder,
 }
 
 /**
- * camel_folder_get_name:
+ * camel_folder_get_full_name:
  * @folder: a #CamelFolder
  *
- * Returns the short name of the folder.  The fully qualified name
- * can be obtained with camel_folder_get_full_name().
+ * Returns the fully qualified name of the folder.
  *
- * Returns: the short name of the folder
+ * Returns: the fully qualified name of the folder
  **/
 const gchar *
-camel_folder_get_name (CamelFolder *folder)
+camel_folder_get_full_name (CamelFolder *folder)
 {
 	g_return_val_if_fail (CAMEL_IS_FOLDER (folder), NULL);
 
-	return folder->priv->name;
+	return folder->priv->full_name;
 }
 
 /**
- * camel_folder_set_name:
+ * camel_folder_set_full_name:
  * @folder: a #CamelFolder
- * @name: a name for the folder
+ * @full_name: a fully qualified name for the folder
  *
- * Sets the short name of the folder.
+ * Sets the fully qualified name of the folder.
  *
  * Since: 2.32
  **/
 void
-camel_folder_set_name (CamelFolder *folder,
-                       const gchar *name)
+camel_folder_set_full_name (CamelFolder *folder,
+                            const gchar *full_name)
 {
 	g_return_if_fail (CAMEL_IS_FOLDER (folder));
 
-	g_free (folder->priv->name);
-	folder->priv->name = g_strdup (name);
+	g_free (folder->priv->full_name);
+	folder->priv->full_name = g_strdup (full_name);
 
-	g_object_notify (G_OBJECT (folder), "name");
+	g_object_notify (G_OBJECT (folder), "full-name");
 }
 
 /**
- * camel_folder_get_full_name:
+ * camel_folder_get_display_name:
  * @folder: a #CamelFolder
  *
- * Returns the fully qualified name of the folder.
+ * Returns the display name for the folder.  The fully qualified name
+ * can be obtained with camel_folder_get_full_name().
  *
- * Returns: the fully qualified name of the folder
+ * Returns: the display name of the folder
  **/
 const gchar *
-camel_folder_get_full_name (CamelFolder *folder)
+camel_folder_get_display_name (CamelFolder *folder)
 {
 	g_return_val_if_fail (CAMEL_IS_FOLDER (folder), NULL);
 
-	return folder->priv->full_name;
+	return folder->priv->display_name;
 }
 
 /**
- * camel_folder_set_full_name:
+ * camel_folder_set_display_name:
  * @folder: a #CamelFolder
- * @full_name: a fully qualified name for the folder
+ * @name: a display name for the folder
  *
- * Sets the fully qualified name of the folder.
+ * Sets the display name for the folder.
  *
  * Since: 2.32
  **/
 void
-camel_folder_set_full_name (CamelFolder *folder,
-                            const gchar *full_name)
+camel_folder_set_display_name (CamelFolder *folder,
+                               const gchar *display_name)
 {
 	g_return_if_fail (CAMEL_IS_FOLDER (folder));
 
-	g_free (folder->priv->full_name);
-	folder->priv->full_name = g_strdup (full_name);
+	g_free (folder->priv->display_name);
+	folder->priv->display_name = g_strdup (display_name);
 
-	g_object_notify (G_OBJECT (folder), "full-name");
+	g_object_notify (G_OBJECT (folder), "display-name");
 }
 
 /**
diff --git a/camel/camel-folder.h b/camel/camel-folder.h
index 01abda3..dbc033b 100644
--- a/camel/camel-folder.h
+++ b/camel/camel-folder.h
@@ -338,12 +338,12 @@ void		camel_folder_set_lock_async	(CamelFolder *folder,
 						 gboolean skip_folder_lock);
 struct _CamelStore *
 		camel_folder_get_parent_store	(CamelFolder *folder);
-const gchar *	camel_folder_get_name		(CamelFolder *folder);
-void		camel_folder_set_name		(CamelFolder *folder,
-						 const gchar *name);
 const gchar *	camel_folder_get_full_name	(CamelFolder *folder);
 void		camel_folder_set_full_name	(CamelFolder *folder,
 						 const gchar *full_name);
+const gchar *	camel_folder_get_display_name	(CamelFolder *folder);
+void		camel_folder_set_display_name	(CamelFolder *folder,
+						 const gchar *display_name);
 const gchar *	camel_folder_get_description	(CamelFolder *folder);
 void		camel_folder_set_description	(CamelFolder *folder,
 						 const gchar *description);
diff --git a/camel/camel-vee-folder.c b/camel/camel-vee-folder.c
index 6e1a836..c3f3ad4 100644
--- a/camel/camel-vee-folder.c
+++ b/camel/camel-vee-folder.c
@@ -1267,7 +1267,7 @@ vee_folder_get_message_sync (CamelFolder *folder,
 			error, CAMEL_FOLDER_ERROR,
 			CAMEL_FOLDER_ERROR_INVALID_UID,
 			_("No such message %s in %s"), uid,
-			camel_folder_get_name (folder));
+			camel_folder_get_display_name (folder));
 	}
 
 	return msg;
diff --git a/camel/camel-vee-store.c b/camel/camel-vee-store.c
index e78f645..fadfae0 100644
--- a/camel/camel-vee-store.c
+++ b/camel/camel-vee-store.c
@@ -201,13 +201,13 @@ vee_store_get_folder_info_sync (CamelStore *store,
 	for (i=0;i<folders->len;i++) {
 		CamelVeeFolder *folder = folders->pdata[i];
 		const gchar *full_name;
-		const gchar *name;
+		const gchar *display_name;
 		gint add = FALSE;
 		gchar *pname, *tmp;
 		CamelFolderInfo *pinfo;
 
-		name = camel_folder_get_name (CAMEL_FOLDER (folder));
 		full_name = camel_folder_get_full_name (CAMEL_FOLDER (folder));
+		display_name = camel_folder_get_display_name (CAMEL_FOLDER (folder));
 
 		/* check we have to include this one */
 		if (top) {
@@ -226,8 +226,6 @@ vee_store_get_folder_info_sync (CamelStore *store,
 				|| strchr (full_name, '/') == NULL;
 		}
 
-		d (printf ("%sadding '%s'\n", add?"":"not ", name));
-
 		if (add) {
 			gint32 unread;
 
@@ -242,7 +240,7 @@ vee_store_get_folder_info_sync (CamelStore *store,
 
 			info = camel_folder_info_new ();
 			info->full_name = g_strdup (full_name);
-			info->display_name = g_strdup (name);
+			info->display_name = g_strdup (display_name);
 			info->unread = unread;
 			info->flags =
 				CAMEL_FOLDER_NOCHILDREN |
diff --git a/camel/providers/imap/camel-imap-folder.c b/camel/providers/imap/camel-imap-folder.c
index de70fcf..8d2499f 100644
--- a/camel/providers/imap/camel-imap-folder.c
+++ b/camel/providers/imap/camel-imap-folder.c
@@ -994,7 +994,7 @@ imap_rescan (CamelFolder *folder,
 	/* Check UIDs and flags of all messages we already know of. */
 	camel_operation_push_message (
 		cancellable, _("Scanning for changed messages in %s"),
-		camel_folder_get_name (folder));
+		camel_folder_get_display_name (folder));
 	uid = camel_folder_summary_uid_from_index (folder->summary, summary_len - 1);
 
 	if (!uid) {
@@ -3969,7 +3969,7 @@ imap_update_summary (CamelFolder *folder,
 	camel_operation_push_message (
 		cancellable,
 		_("Fetching summary information for new messages in %s"),
-		camel_folder_get_name (folder));
+		camel_folder_get_display_name (folder));
 
 	/* Parse the responses. We can't add a message to the summary
 	 * until we've gotten its headers, and there's no guarantee
@@ -4051,7 +4051,7 @@ imap_update_summary (CamelFolder *folder,
 		camel_operation_push_message (
 			cancellable,
 			_("Fetching summary information for new messages in %s"),
-			camel_folder_get_name (folder));
+			camel_folder_get_display_name (folder));
 
 		while (uid < needheaders->len && !camel_application_is_exiting) {
 			uidset = imap_uid_array_to_set (folder->summary, needheaders, uid, UID_SET_LIMIT, &uid);
diff --git a/camel/providers/imapx/camel-imapx-server.c b/camel/providers/imapx/camel-imapx-server.c
index 78c2c2c..f99d4bf 100644
--- a/camel/providers/imapx/camel-imapx-server.c
+++ b/camel/providers/imapx/camel-imapx-server.c
@@ -3895,7 +3895,7 @@ imapx_job_scan_changes_done (CamelIMAPXServer *is,
 			camel_operation_push_message (
 				job->cancellable,
 				_("Fetching summary information for new messages in %s"),
-				camel_folder_get_name (job->folder));
+				camel_folder_get_display_name (job->folder));
 			imapx_uidset_init (&job->u.refresh_info.uidset, BATCH_FETCH_COUNT, 0);
 			/* These are new messages which arrived since we last knew the unseen count;
 			   update it as they arrive. */
@@ -3939,7 +3939,7 @@ imapx_job_scan_changes_start (CamelIMAPXServer *is,
 	camel_operation_push_message (
 		job->cancellable,
 		_("Scanning for changed messages in %s"),
-		camel_folder_get_name (job->folder));
+		camel_folder_get_display_name (job->folder));
 
 	ic = camel_imapx_command_new (
 		is, "FETCH", job->folder, job->cancellable,
@@ -4026,7 +4026,7 @@ imapx_job_fetch_new_messages_start (CamelIMAPXServer *is,
 	camel_operation_push_message (
 		job->cancellable,
 		_("Fetching summary information for new messages in %s"),
-		camel_folder_get_name (folder));
+		camel_folder_get_display_name (folder));
 
 	if (diff > BATCH_FETCH_COUNT) {
 		ic = camel_imapx_command_new (
diff --git a/docs/reference/camel/camel-sections.txt b/docs/reference/camel/camel-sections.txt
index 2c6829d..c7bc89d 100644
--- a/docs/reference/camel/camel-sections.txt
+++ b/docs/reference/camel/camel-sections.txt
@@ -428,10 +428,10 @@ CamelFolderChangeInfo
 CamelFolderQuotaInfo
 camel_folder_set_lock_async
 camel_folder_get_parent_store
-camel_folder_get_name
-camel_folder_set_name
 camel_folder_get_full_name
 camel_folder_set_full_name
+camel_folder_get_display_name
+camel_folder_set_display_name
 camel_folder_get_description
 camel_folder_set_description
 camel_folder_get_permanent_flags
diff --git a/docs/reference/camel/tmpl/camel-folder.sgml b/docs/reference/camel/tmpl/camel-folder.sgml
index bd7c5ba..ad02745 100644
--- a/docs/reference/camel/tmpl/camel-folder.sgml
+++ b/docs/reference/camel/tmpl/camel-folder.sgml
@@ -67,12 +67,12 @@ CamelFolder
 
 </para>
 
-<!-- ##### ARG CamelFolder:full-name ##### -->
+<!-- ##### ARG CamelFolder:display-name ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG CamelFolder:name ##### -->
+<!-- ##### ARG CamelFolder:full-name ##### -->
 <para>
 
 </para>
@@ -142,7 +142,7 @@ CamelFolder
 @Returns: 
 
 
-<!-- ##### FUNCTION camel_folder_get_name ##### -->
+<!-- ##### FUNCTION camel_folder_get_full_name ##### -->
 <para>
 
 </para>
@@ -151,16 +151,16 @@ CamelFolder
 @Returns: 
 
 
-<!-- ##### FUNCTION camel_folder_set_name ##### -->
+<!-- ##### FUNCTION camel_folder_set_full_name ##### -->
 <para>
 
 </para>
 
 @folder: 
- name: 
+ full_name: 
 
 
-<!-- ##### FUNCTION camel_folder_get_full_name ##### -->
+<!-- ##### FUNCTION camel_folder_get_display_name ##### -->
 <para>
 
 </para>
@@ -169,13 +169,13 @@ CamelFolder
 @Returns: 
 
 
-<!-- ##### FUNCTION camel_folder_set_full_name ##### -->
+<!-- ##### FUNCTION camel_folder_set_display_name ##### -->
 <para>
 
 </para>
 
 @folder: 
- full_name: 
+ display_name: 
 
 
 <!-- ##### FUNCTION camel_folder_get_description ##### -->
diff --git a/docs/reference/camel/tmpl/camel-unused.sgml b/docs/reference/camel/tmpl/camel-unused.sgml
index cd1d428..b6a4386 100644
--- a/docs/reference/camel/tmpl/camel-unused.sgml
+++ b/docs/reference/camel/tmpl/camel-unused.sgml
@@ -3268,6 +3268,12 @@ streams
 </para>
 
 
+<!-- ##### ARG CamelFolder:name ##### -->
+<para>
+
+</para>
+
+
 <!-- ##### ARG CamelFolder:uri ##### -->
 <para>
 
@@ -5446,6 +5452,14 @@ streams
 @full_name: 
 @name: 
 
+<!-- ##### FUNCTION camel_folder_get_name ##### -->
+<para>
+
+</para>
+
+ folder: 
+ Returns: 
+
 <!-- ##### FUNCTION camel_folder_get_uri ##### -->
 <para>
 
@@ -5454,6 +5468,14 @@ streams
 @folder: 
 @Returns: 
 
+<!-- ##### FUNCTION camel_folder_set_name ##### -->
+<para>
+
+</para>
+
+ folder: 
+ name: 
+
 <!-- ##### FUNCTION camel_folder_summary_array_free ##### -->
 <para>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]