Mercurial > pidgin.yaz
diff finch/libgnt/gnttextview.h @ 20453:69febfa6d307
propagate from branch 'im.pidgin.pidgin' (head d3e5a5add3f39caa08b46c83177328e51c2d961a)
to branch 'im.pidgin.cpw.khc.msnp14' (head a8f6c999b039b4097aa70cd8d2597f3127615435)
author | Carlos Silva <typ0@pidgin.im> |
---|---|
date | Sat, 16 Jun 2007 04:00:32 +0000 |
parents | 1cedd520cd18 |
children | 5c6f019e48f8 |
line wrap: on
line diff
--- a/finch/libgnt/gnttextview.h Sun Jun 03 01:06:44 2007 +0000 +++ b/finch/libgnt/gnttextview.h Sat Jun 16 04:00:32 2007 +0000 @@ -1,3 +1,25 @@ +/** + * GNT - The GLib Ncurses Toolkit + * + * GNT is the legal property of its developers, whose names are too numerous + * to list here. Please refer to the COPYRIGHT file distributed with this + * source distribution. + * + * This library 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; either version 2 of the License, or + * (at your option) any later version. + * + * 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 GNT_TEXT_VIEW_H #define GNT_TEXT_VIEW_H @@ -53,34 +75,102 @@ G_BEGIN_DECLS +/** + * + * + * @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. */ -GntWidget *gnt_text_view_new(void); +/** + * + * + * @return + */ +GntWidget * gnt_text_view_new(void); /* scroll > 0 means scroll up, < 0 means scroll down, == 0 means scroll to the end */ +/** + * + * @param view + * @param scroll + */ void gnt_text_view_scroll(GntTextView *view, int scroll); +/** + * + * @param view + * @param text + * @param flags + */ void gnt_text_view_append_text_with_flags(GntTextView *view, const char *text, GntTextFormatFlags flags); +/** + * + * @param view + * @param text + * @param flags + * @param tag + */ 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. */ +/** + * + * @param view + */ void gnt_text_view_next_line(GntTextView *view); +/** + * + * @param flags + * + * @return + */ chtype gnt_text_format_flag_to_chtype(GntTextFormatFlags flags); +/** + * + * @param view + */ void gnt_text_view_clear(GntTextView *view); +/** + * + * @param view + * + * @return + */ int gnt_text_view_get_lines_below(GntTextView *view); +/** + * + * @param view + * + * @return + */ int gnt_text_view_get_lines_above(GntTextView *view); /* If text is NULL, then the tag is removed. */ +/** + * + * @param view + * @param name + * @param text + * @param all + * + * @return + */ int gnt_text_view_tag_change(GntTextView *view, const char *name, const char *text, gboolean all); +/** + * + * @param view + * @param widget + */ void gnt_text_view_attach_scroll_widget(GntTextView *view, GntWidget *widget); G_END_DECLS