diff libpurple/protocols/novell/nmmessage.h @ 15373:5fe8042783c1

Rename gtk/ and libgaim/ to pidgin/ and libpurple/
author Sean Egan <seanegan@gmail.com>
date Sat, 20 Jan 2007 02:32:10 +0000
parents
children 44b4e8bd759b
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/libpurple/protocols/novell/nmmessage.h	Sat Jan 20 02:32:10 2007 +0000
@@ -0,0 +1,83 @@
+/*
+ * nmmessage.h
+ *
+ * Copyright (c) 2004 Novell, Inc. All Rights Reserved.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA	02111-1307	USA
+ *
+ */
+
+#ifndef __NM_MESSAGE_H__
+#define __NM_MESSAGE_H__
+
+typedef struct _NMMessage NMMessage;
+
+#include "nmconference.h"
+
+/**
+ * Creates a new message.
+ *
+ * The returned message should be released by calling
+ * nm_release_message
+ *
+ * @param	text	The message text
+ * @return			A newly allocated message
+ */
+NMMessage *nm_create_message(const char *text);
+
+/**
+ * Increment the reference count for the message object.
+ *
+ * @param	msg		The message
+ */
+void nm_message_add_ref(NMMessage * msg);
+
+/**
+ * Releases a message.
+ *
+ * @param	msg		The message
+ */
+void nm_release_message(NMMessage * msg);
+
+/**
+ * Returns the message text
+ *
+ * @param	msg		The message
+ * @return 			The message text
+ */
+const char *nm_message_get_text(NMMessage * msg);
+
+/**
+ * Sets the conference object for a message
+ *
+ * @param	msg		The message
+ * @param	conf	The conference to associate with the message
+ * @return			RVALUE_OK on success
+ */
+void nm_message_set_conference(NMMessage * msg, NMConference * conf);
+
+/**
+ * Returns the conference object associated with the message
+ *
+ * Note: this does not increment the reference count for the
+ * conference and the conference should NOT be released with
+ * nm_release_conference. If the reference needs to be kept
+ * around nm_conference_add_ref should be called.
+ *
+ * @param	msg		The message
+ * @return			The conference associated with this message
+ */
+NMConference *nm_message_get_conference(NMMessage * msg);
+
+#endif