From 0eb1ac797f7bb6aa66b19eb7a0383609ae2bc925 Mon Sep 17 00:00:00 2001 From: engelsman Date: Sat, 4 Oct 2008 12:21:46 +0000 Subject: added doxygen comments for undocumented features of Fl_File_Icon git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6371 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_File_Icon.H | 50 ++++++++++++++++++++++++++++++-------------------- 1 file changed, 30 insertions(+), 20 deletions(-) (limited to 'FL/Fl_File_Icon.H') diff --git a/FL/Fl_File_Icon.H b/FL/Fl_File_Icon.H index eba02b69d..001ce15a7 100644 --- a/FL/Fl_File_Icon.H +++ b/FL/Fl_File_Icon.H @@ -3,7 +3,7 @@ // // Fl_File_Icon definitions. // -// Copyright 1999-2005 by Michael Sweet. +// Copyright 1999-2008 by Michael Sweet. // // This library is free software; you can redistribute it and/or // modify it under the terms of the GNU Library General Public @@ -42,7 +42,7 @@ // Special color value for the icon color. // -# define FL_ICON_COLOR (Fl_Color)0xffffffff +# define FL_ICON_COLOR (Fl_Color)0xffffffff /**< icon color [background?]*/ // @@ -90,57 +90,67 @@ class FL_EXPORT Fl_File_Icon //// Icon data ~Fl_File_Icon(); short *add(short d); - /** Adds a color value to the icon array, returning a pointer to it.*/ + + /** + Adds a color value to the icon array, returning a pointer to it. + \param[in] c color value + */ short *add_color(Fl_Color c) { short *d = add((short)COLOR); add((short)(c >> 16)); add((short)c); return (d); } + /** Adds a vertex value to the icon array, returning a pointer to it. - The integer version accepts coordinates from 0 to 10000, while the - floating point version goes from 0.0 to 1.0. The origin (0.0) is in - the lower-lefthand corner of the icon. + The integer version accepts coordinates from 0 to 10000. + The origin (0.0) is in the lower-lefthand corner of the icon. + \param[in] x, y vertex coordinates */ short *add_vertex(int x, int y) { short *d = add((short)VERTEX); add((short)x); add((short)y); return (d); } + /** Adds a vertex value to the icon array, returning a pointer to it. - The integer version accepts coordinates from 0 to 10000, while the - floating point version goes from 0.0 to 1.0. The origin (0.0) is in - the lower-lefthand corner of the icon. + The floating point version goes from 0.0 to 1.0. + The origin (0.0) is in the lower-lefthand corner of the icon. + \param[in] x, y vertex coordinates */ short *add_vertex(float x, float y) { short *d = add((short)VERTEX); add((short)(x * 10000.0)); add((short)(y * 10000.0)); return (d); } + /** Clears all icon data from the icon.*/ void clear() { num_data_ = 0; } - /** Draws the icon in the indicated area.*/ + void draw(int x, int y, int w, int h, Fl_Color ic, int active = 1); - /** Set the widgets label to an icon */ + void label(Fl_Widget *w); - /** The labeltype function for icons.*/ + static void labeltype(const Fl_Label *o, int x, int y, int w, int h, Fl_Align a); void load(const char *f); int load_fti(const char *fti); int load_image(const char *i); + /** Returns next file icon object. See Fl_File_Icon::first() */ Fl_File_Icon *next() { return (next_); } + /** Returns the filename matching pattern for the icon.*/ const char *pattern() { return (pattern_); } + /** Returns the number of words of data used by the icon.*/ int size() { return (num_data_); } + /** Returns the filetype associated with the icon, which can be one of the following: - + \li Fl_File_Icon::ANY, any kind of file. + \li Fl_File_Icon::PLAIN, plain files. + \li Fl_File_Icon::FIFO, named pipes. + \li Fl_File_Icon::DEVICE, character and block devices. + \li Fl_File_Icon::LINK, symbolic links. + \li Fl_File_Icon::DIRECTORY, directories. */ int type() { return (type_); } + /** Returns the data array for the icon.*/ short *value() { return (data_); } -- cgit v1.2.3