From b0e56bb248b4690fc34505f58b8b795521628ff2 Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Thu, 2 Aug 2001 18:31:29 +0000 Subject: Documentation... git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@1529 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Fl_FileIcon.html | 165 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 165 insertions(+) create mode 100644 documentation/Fl_FileIcon.html (limited to 'documentation/Fl_FileIcon.html') diff --git a/documentation/Fl_FileIcon.html b/documentation/Fl_FileIcon.html new file mode 100644 index 000000000..bd60fb93a --- /dev/null +++ b/documentation/Fl_FileIcon.html @@ -0,0 +1,165 @@ + + + FileIcon - ESP Widget Set for FLTK + + + Widget Set Home Page + Widget Set Documentation + Download Widget Set + ESP Home Page + FLTK Home Page + + + + + + +

class FileIcon

+ +
+ +

Class Hierarchy

+ + + +

Include Files

+ + + +

Description

+ +

The FileIcon class manages icon images that can be +used as labels in other widgets and as icons in the FileBrowser +widget. + +

Methods

+ + + +

FileIcon()

+ +

The constructor creates a new FileIcon with the specified +information. + +

~FileIcon()

+ +

The destructor destroys the icon and frees all memory that has been +allocated for it. + +

short *add(short d)

+ +

Adds a keyword value to the icon array, returning a pointer to it. + +

short *add_color(short c)

+ +

Adds a color value to the icon array, returning a pointer to it. + +

short *add_vertex(int x, int y)
+short *add_vertex(float x, float y)

+ +

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. + +

void clear()

+ +

Clears all icon data from the icon. + +

void draw(int x, int y, int w, int h, Fl_Color ic, int active = 1)

+ +

Draws the icon in the indicated area. + +

static FileIcon *find(const char *filename, int filetype = ANY);

+ +

Finds an icon that matches the given filename and file type. + +

static FileIcon *first()

+ +

Returns a pointer to the first icon in the list. + +

void label(Fl_Widget *w)

+ +

Applies the icon to the widget, registering the FileIcon +label type as needed. + +

static void labeltype(const Fl_Label *o, int x, int y, int w, int h, Fl_Align a)

+ +

The labeltype function for icons. + +

void load(const char *f)

+ +

Loads the specified icon image. The format is deduced from the filename. + +

void load_fti(const char *fti)

+ +

Loads an SGI icon file. + +

static void load_system_icons(void)

+ +

Loads all system-defined icons. This call is useful when using the +FileChooser widget and should be used when the application +starts: + +

+ +

void load_xpm(const char *xpm)

+ +

Loads an XPM icon file. + +

const char *pattern()

+ +

Returns the filename matching pattern for the icon. + +

int size()

+ +

Returns the number of words of data used by the icon. + +

int type()

+ +

Returns the filetype associated with the icon, which can be one of the +following: + +

+ +

short *value()

+ +

Returns the data array for the icon. + + + -- cgit v1.2.3