Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

Fl_Menu_Item.h

00001 /*
00002  * $Id: Fl_Menu_Item.h,v 1.2 2003/01/09 16:12:55 laza2000 Exp $
00003  *
00004  * Extended Fast Light Toolkit (EFLTK)
00005  * Copyright (C) 2002-2003 by EDE-Team
00006  * WWW: http://www.sourceforge.net/projects/ede
00007  *
00008  * Fast Light Toolkit (FLTK)
00009  * Copyright (C) 1998-2003 by Bill Spitzak and others.
00010  * WWW: http://www.fltk.org
00011  *
00012  * This library is distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE
00013  * version 2. See COPYING for details.
00014  *
00015  * Author : Mikko Lahteenmaki
00016  * Email  : mikko@fltk.net
00017  *
00018  * Please report all bugs and problems to "efltk-bugs@fltk.net"
00019  *
00020  */
00021 
00022 #ifndef _FL_MENU_ITEM_H_
00023 #define _FL_MENU_ITEM_H_
00024 
00025 #include "Fl_Widget.h"
00026 
00027 enum { // values for flags:
00028     FL_MENU_INACTIVE = 1,
00029     FL_MENU_TOGGLE= 2,
00030     FL_MENU_VALUE = 4,
00031     FL_MENU_RADIO = 8,
00032     FL_MENU_INVISIBLE = 0x10,
00033     FL_SUBMENU_POINTER = 0x20,
00034     FL_SUBMENU = 0x40,
00035     FL_MENU_DIVIDER = 0x80,
00036     FL_MENU_HORIZONTAL = 0x100, // not used!
00037     FL_MENU_RIGHTLAYOUT = 0x200
00038 };
00039 
00040 class FL_API Fl_Menu_;
00041 
00042 struct FL_API Fl_Menu_Item {
00043     const char *text;
00044     int shortcut_;
00045     Fl_Callback *callback_;
00046     void *user_data_;
00047     int flags;
00048     Fl_Labeltype labeltype_;
00049     Fl_Font labelfont_;
00050     unsigned labelsize_;
00051     Fl_Color labelcolor_;
00052 
00053     // Used to add or set an Fl_Menu_ widget:
00054     void add_to(Fl_Menu_*, void* data = 0) const;
00055 
00056     // popup menus without using an Fl_Menu_ widget:
00057     // Warning: this is now quite expensive, as it creates a temporary
00058     // Fl_Menu_ and child widgets!  These also do not match the fltk 1.0
00059     // calls, if there is any callback it is called directly (with the
00060     // dummy Fl_Menu_ as an argument).
00061     const Fl_Menu_Item*
00062         pulldown(int X, int Y, int W, int H,
00063                  const Fl_Menu_Item* picked = 0,
00064                  const char* title = 0) const;
00065     const Fl_Menu_Item*
00066         popup(int X, int Y, const char* title=0,
00067               const Fl_Menu_Item* picked = 0) const {
00068             return pulldown(X, Y, 0, 0, picked, title);}
00069     const Fl_Menu_Item*
00070         test_shortcut() const;
00071 
00072     // return offset of terminating null item:
00073     int size() const ;
00074 
00075     // advance a pointer by N items, skipping submenus:
00076     const Fl_Menu_Item *next(int=1) const;
00077     Fl_Menu_Item *next(int i=1) {
00078         return (Fl_Menu_Item*)(((const Fl_Menu_Item*)this)->next(i));}
00079 
00080     const char* label() const {return text;}
00081     Fl_Labeltype labeltype() const {return labeltype_;}
00082     Fl_Color labelcolor() const {return labelcolor_;}
00083     Fl_Font labelfont() const {return labelfont_;}
00084     unsigned labelsize() const {return labelsize_;}
00085     Fl_Callback_p callback() const {return callback_;}
00086     void* user_data() const {return user_data_;}
00087     long argument() const {return (long)user_data_;}
00088     int shortcut() const {return shortcut_;}
00089     int submenu() const {return flags&(FL_SUBMENU|FL_SUBMENU_POINTER);}
00090     int checkbox() const {return flags&FL_MENU_TOGGLE;}
00091     int radio() const {return flags&FL_MENU_RADIO;}
00092     int value() const {return flags&FL_MENU_VALUE;}
00093     int visible() const {return !(flags&FL_MENU_INVISIBLE);}
00094     int active() const {return !(flags&FL_MENU_INACTIVE);}
00095     int activevisible() const {return !(flags&0x11);}
00096 
00097     void label(const char* a) {text=a;}
00098     void label(Fl_Labeltype a,const char* b) {labeltype_ = a; text = b;}
00099     void labeltype(Fl_Labeltype a) {labeltype_ = a;}
00100     void labelcolor(uchar a) {labelcolor_ = a;}
00101     void labelfont(Fl_Font a) {labelfont_ = a;}
00102     void labelsize(uchar a) {labelsize_ = a;}
00103     void callback(Fl_Callback* c, void* p) {callback_=c; user_data_=p;}
00104     void callback(Fl_Callback* c) {callback_=c;}
00105     void callback(Fl_Callback0*c) {callback_=(Fl_Callback*)c;}
00106     void callback(Fl_Callback1*c, long p=0) {callback_=(Fl_Callback*)c; user_data_=(void*)p;}
00107     void user_data(void* v) {user_data_ = v;}
00108     void argument(long v) {user_data_ = (void*)v;}
00109     void shortcut(int s) {shortcut_ = s;}
00110     void set() {flags |= FL_MENU_VALUE;}
00111     void clear() {flags &= ~FL_MENU_VALUE;}
00112     void setonly();
00113     void show() {flags &= ~FL_MENU_INVISIBLE;}
00114     void hide() {flags |= FL_MENU_INVISIBLE;}
00115     void activate() {flags &= ~FL_MENU_INACTIVE;}
00116     void deactivate() {flags |= FL_MENU_INACTIVE;}
00117 
00118     const Fl_Menu_Item* find_shortcut(int *ip=0) const;
00119 
00120     void do_callback(Fl_Widget* o) const {callback_(o, user_data_);}
00121     void do_callback(Fl_Widget* o,void* arg) const {callback_(o, arg);}
00122     void do_callback(Fl_Widget* o,long arg) const {callback_(o, (void*)arg);}
00123 
00124     // back-compatability, do not use:
00125     int checked() const {return flags&FL_MENU_VALUE;}
00126     void check() {flags |= FL_MENU_VALUE;}
00127     void uncheck() {flags &= ~FL_MENU_VALUE;}
00128 };
00129 
00130 #endif

Generated on Thu Jul 31 15:33:44 2003 for eFLTK by doxygen1.2.15