pidgin3: comparison finch/libgnt/gnttextview.h

-:470dea577276
+:81d324f460bd
 };
 G_BEGIN_DECLS
 /**
-*
+* @return  GType for GntTextView.
-*
-* @return
 */
 GType gnt_text_view_get_gtype(void);
-/* XXX: For now, don't set a textview to have any border.
+/**
-*      If you want borders real bad, put it in a box. */
+* Create a new textview.
-/**
+*
-*
+* @return The newly created textview.
-*
-* @return
 */
 GntWidget * gnt_text_view_new(void);
-/* scroll > 0 means scroll up, < 0 means scroll down, == 0 means scroll to the end */
+/**
-/**
+* Scroll the textview.
-*
+* @param view     The textview to scroll.
-* @param view
+* @param scroll   scroll > 0 means scroll up, < 0 means scroll down, == 0 means scroll to the end.
-* @param scroll
 */
 void gnt_text_view_scroll(GntTextView *view, int scroll);
 /**
-*
+* Append new text in a textview.
-* @param view
+*
-* @param text
+* @param view   The textview.
-* @param flags
+* @param text   The text to append to the textview.
+* @param flags  The text-flags to apply to the new text.
 */
 void gnt_text_view_append_text_with_flags(GntTextView *view, const char *text, GntTextFormatFlags flags);
 /**
-*
+* Append text in the textview, with some identifier (tag) for the added text.
-* @param view
+*
-* @param text
+* @param view   The textview.
-* @param flags
+* @param text   The text to append.
-* @param tag
+* @param flags  The text-flags to apply to the new text.
+* @param tag    The tag for the appended text, so it can be changed later (@see gnt_text_view_tag_change)
 */
 void gnt_text_view_append_text_with_tag(GntTextView *view, const char *text, GntTextFormatFlags flags, const char *tag);
-/* Move the cursor to the beginning of the next line and resets text-attributes.
+/**
-* It first completes the current line with the current text-attributes. */
+* Move the cursor to the beginning of the next line and resets text-attributes.
-/**
+* It first completes the current line with the current text-attributes.
 *
-* @param view
+* @param view  The textview.
 */
 void gnt_text_view_next_line(GntTextView *view);
 /**
-*
+* Convert GNT-text formats to ncurses-text attributes.
-* @param flags
+*
-*
+* @param flags  The GNT text format.
-* @return
+*
+* @return  Nucrses text attribute.
 */
 chtype gnt_text_format_flag_to_chtype(GntTextFormatFlags flags);
 /**
-*
+* Clear the contents of the textview.
-* @param view
+*
+* @param view  The textview.
 */
 void gnt_text_view_clear(GntTextView *view);
 /**
-*
+* The number of lines below the bottom-most visible line.
-* @param view
+*
-*
+* @param view  The textview.
-* @return
+*
+* @return  Number of lines below the bottom-most visible line.
 */
 int gnt_text_view_get_lines_below(GntTextView *view);
 /**
-*
+* The number of lines above the topmost visible line.
-* @param view
+*
-*
+* @param view  The textview.
-* @return
+*
+* @return  Number of lines above the topmost visible line.
 */
 int gnt_text_view_get_lines_above(GntTextView *view);
-/* If text is NULL, then the tag is removed. */
+/**
-/**
+* Change the text of a tag.
 *
-* @param view
+* @param view   The textview.
-* @param name
+* @param name   The name of the tag.
-* @param text
+* @param text   The new text for the text. If 'text' is @c NULL, the tag is removed.
-* @param all
+* @param all    @c TRUE if all of the instancess of the tag should be changed, @c FALSE if
-*
+*               only the first instance should be changed.
-* @return
+*
+* @return  The number of instances changed.
 */
 int gnt_text_view_tag_change(GntTextView *view, const char *name, const char *text, gboolean all);
 /**
-*
+* Setup hooks so that pressing up/down/page-up/page-down keys when 'widget' is
-* @param view
+* in focus scrolls the textview.
-* @param widget
+*
+* @param view    The textview.
+* @param widget  The trigger widget.
 */
 void gnt_text_view_attach_scroll_widget(GntTextView *view, GntWidget *widget);
 /**
-*
+* Setup appropriate hooks so that pressing some keys when the 'pager' widget
-* @param view
+* is in focus triggers the PAGER to popup with the contents of the textview
-* @param widget
+* in it.
+*
+* The default key-combination to trigger the pager is a-v, and the default
+* PAGER application is $PAGER. Both can be changed in ~/.gntrc like this:
+*
+* @code
+* [pager]
+* key = a-v
+* path = /path/to/pager
+* @endcode
+*
+* @param view    The textview.
+* @param pager   The widget to trigger the PAGER.
 */
 void gnt_text_view_attach_pager_widget(GntTextView *view, GntWidget *pager);
 /**
-*
+* Setup appropriate hooks so that pressing some keys when 'widget'
-* @param view
+* is in focus triggers the EDITOR to popup with the contents of the textview
-* @param widget
+* in it.
-*/
+*
-void gnt_text_view_attach_editor_widget(GntTextView *view, GntWidget *pager);
+* The default key-combination to trigger the pager is a-e, and the default
+* EDITOR application is $EDITOR. Both can be changed in ~/.gntrc like this:
+*
+* @code
+* [editor]
+* key = a-e
+* path = /path/to/editor
+* @endcode
+*
+* @param view     The textview.
+* @param widget   The widget to trigger the EDITOR.
+*/
+void gnt_text_view_attach_editor_widget(GntTextView *view, GntWidget *widget);
 /**
 * Set a GntTextViewFlag for the textview widget.
 *
 * @param view  The textview widget

Mercurial > pidgin3 / file comparison

comparison: finch/libgnt/gnttextview.h

finch/libgnt/gnttextview.h