]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtktextbufferrichtext.h
filechooserbutton: Emit 'selection-changed' when changing the selection programmatically
[~andy/gtk] / gtk / gtktextbufferrichtext.h
index 96fc3c969b87a72981ae38969f8db9ed1a18a14f..44034dffb9217f7ae92e4e3993bb85935b2fcf84 100644 (file)
  * Library General Public License for more details.
  *
  * You should have received a copy of the GNU Library General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef __GTK_TEXT_BUFFER_RICH_TEXT_H__
 #define __GTK_TEXT_BUFFER_RICH_TEXT_H__
 
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
 #include <gtk/gtktextbuffer.h>
 
 G_BEGIN_DECLS
 
+/**
+ * GtkTextBufferSerializeFunc:
+ * @register_buffer: the #GtkTextBuffer for which the format is registered
+ * @content_buffer: the #GtkTextBuffer to serialize
+ * @start: start of the block of text to serialize
+ * @end: end of the block of text to serialize
+ * @length: Return location for the length of the serialized data
+ * @user_data: user data that was specified when registering the format
+ *
+ * A function that is called to serialize the content of a text buffer.
+ * It must return the serialized form of the content.
+ *
+ * Returns: a newly-allocated array of guint8 which contains the serialized
+ *   data, or %NULL if an error occurred
+ */
 typedef guint8 * (* GtkTextBufferSerializeFunc)   (GtkTextBuffer     *register_buffer,
                                                    GtkTextBuffer     *content_buffer,
                                                    const GtkTextIter *start,
                                                    const GtkTextIter *end,
                                                    gsize             *length,
                                                    gpointer           user_data);
+
+/**
+ * GtkTextBufferDeserializeFunc:
+ * @register_buffer: the #GtkTextBuffer the format is registered with
+ * @content_buffer: the #GtkTextBuffer to deserialize into
+ * @iter: insertion point for the deserialized text
+ * @data: data to deserialize
+ * @length: length of %data
+ * @create_tags: %TRUE if deserializing may create tags
+ * @user_data: user data that was specified when registering the format
+ * @error: return location for a #GError
+ *
+ * A function that is called to deserialize rich text that has been
+ * serialized with gtk_text_buffer_serialize(), and insert it at @iter.
+ *
+ * Returns: %TRUE on success, %FALSE otherwise
+ */
 typedef gboolean (* GtkTextBufferDeserializeFunc) (GtkTextBuffer     *register_buffer,
                                                    GtkTextBuffer     *content_buffer,
                                                    GtkTextIter       *iter,