Fl_Menu_Item.H

Go to the documentation of this file.

//
// Menu item header file for the Fast Light Tool Kit (FLTK).
//
// Copyright 1998-2024 by Bill Spitzak and others.
//
// This library is free software. Distribution and use rights are outlined in
// the file "COPYING" which should have been included with this file.  If this
// file is missing or damaged, see the license at:
//
//     https://www.fltk.org/COPYING.php
//
// Please see the following page on how to report bugs and issues:
//
//     https://www.fltk.org/bugs.php
//
 
#ifndef Fl_Menu_Item_H
#define Fl_Menu_Item_H
 
#include <FL/Fl_Widget.H>
#include <FL/Fl_Image.H>
#include <FL/Fl_Multi_Label.H>
#include <FL/platform_types.h> // for FL_COMMAND and FL_CONTROL
 
// doxygen needs the following line to enable e.g. ::FL_MENU_TOGGLE to link to the enums
 
enum { // values for flags:
  FL_MENU_INACTIVE   = 1,          
  FL_MENU_TOGGLE     = 2,          
  FL_MENU_VALUE      = 4,          
  FL_MENU_RADIO      = 8,          
  FL_MENU_INVISIBLE  = 0x10,       
  FL_SUBMENU_POINTER = 0x20,       
  FL_SUBMENU         = 0x40,       
  FL_MENU_DIVIDER    = 0x80,       
  FL_MENU_HORIZONTAL = 0x100       
};
 
extern FL_EXPORT Fl_Shortcut fl_old_shortcut(const char*);
 
class Fl_Menu_;

struct FL_EXPORT Fl_Menu_Item {
  const char *text;         
  int shortcut_;            
  Fl_Callback *callback_;   
  void *user_data_;         
  int flags;                
  uchar labeltype_;         
  Fl_Font labelfont_;       
  Fl_Fontsize labelsize_;   
  Fl_Color labelcolor_;     
 
  // advance N items, skipping submenus:
  const Fl_Menu_Item *next(int=1) const;

  Fl_Menu_Item *next(int i=1) {
    return (Fl_Menu_Item*)(((const Fl_Menu_Item*)this)->next(i));}

  const Fl_Menu_Item *first() const { return next(0); }

  Fl_Menu_Item *first() { return next(0); }
 
  // methods on menu items:
  const char* label() const { return text; }

  void label(const char* a) { text = a; }

  void label(Fl_Labeltype a, const char* b) {
    labeltype_ = a;
    text = b;
  }

  void multi_label(const Fl_Multi_Label *ml) {
    label(FL_MULTI_LABEL, (const char *)ml);
  }

  void image_label(const Fl_Image *image) {
    label(FL_IMAGE_LABEL, (const char *)image);
  }

  Fl_Labeltype labeltype() const {return (Fl_Labeltype)labeltype_;}

  void labeltype(Fl_Labeltype a) {labeltype_ = a;}

  Fl_Color labelcolor() const {return labelcolor_;}

  void labelcolor(Fl_Color a) {labelcolor_ = a;}
  Fl_Font labelfont() const {return labelfont_;}

  void labelfont(Fl_Font a) {labelfont_ = a;}

  Fl_Fontsize labelsize() const {return labelsize_;}

  void labelsize(Fl_Fontsize a) {labelsize_ = a;}

  Fl_Callback_p callback() const {return callback_;}

  void callback(Fl_Callback* c, void* p) {callback_=c; user_data_=p;}

  void callback(Fl_Callback* c) {callback_=c;}

  void callback(Fl_Callback0 *c) {
    callback_ = (Fl_Callback *)(void *)c;
  }

  void callback(Fl_Callback1 *c, long p = 0) {
    callback_ = (Fl_Callback *)(void *)c;
    user_data_ = (void *)(fl_intptr_t)p;
  }

  void* user_data() const {return user_data_;}
  void user_data(void* v) {user_data_ = v;}
  long argument() const {return (long)(fl_intptr_t)user_data_;}
  void argument(long v) {user_data_ = (void*)(fl_intptr_t)v;}

  int shortcut() const {return shortcut_;}

  void shortcut(int s) {shortcut_ = s;}
  int submenu() const {return flags&(FL_SUBMENU|FL_SUBMENU_POINTER);}
  int checkbox() const {return flags&FL_MENU_TOGGLE;}
  int radio() const {return flags&FL_MENU_RADIO;}
  int value() const {return (flags & FL_MENU_VALUE) ? 1 : 0;}

  void value(int v) { v ? set() : clear(); }

  void set() {flags |= FL_MENU_VALUE;}

  void clear() {flags &= ~FL_MENU_VALUE;}
 
  void setonly(Fl_Menu_Item const* first = NULL);

  int visible() const {return !(flags&FL_MENU_INVISIBLE);}

  void show() {flags &= ~FL_MENU_INVISIBLE;}

  void hide() {flags |= FL_MENU_INVISIBLE;}

  int active() const {return !(flags&FL_MENU_INACTIVE);}

  void activate() {flags &= ~FL_MENU_INACTIVE;}
  void deactivate() {flags |= FL_MENU_INACTIVE;}
  int activevisible() const {return !(flags & (FL_MENU_INACTIVE|FL_MENU_INVISIBLE));}
 
  // compatibility for FLUID so it can set the image of a menu item...

  void image(Fl_Image* image) {image->label(this);}

  void image(Fl_Image& image) {image.label(this);}
 
  // used by menubar:
  int measure(int* h, const Fl_Menu_*) const;
  void draw(int x, int y, int w, int h, const Fl_Menu_*, int t=0) const;
 
  // popup menus without using an Fl_Menu_ widget:
  const Fl_Menu_Item* popup(
    int X, int Y,
    const char *title = 0,
    const Fl_Menu_Item* picked=0,
    const Fl_Menu_* = 0) const;
  const Fl_Menu_Item* pulldown(
    int X, int Y, int W, int H,
    const Fl_Menu_Item* picked = 0,
    const Fl_Menu_* = 0,
    const Fl_Menu_Item* title = 0,
    int menubar=0) const;
  const Fl_Menu_Item* test_shortcut() const;
  const Fl_Menu_Item* find_shortcut(int *ip=0, const bool require_alt = false) const;

  void do_callback(Fl_Widget* o) const {Fl::callback_reason_=FL_REASON_SELECTED; callback_(o, user_data_);}

  void do_callback(Fl_Widget* o,void* arg) const {Fl::callback_reason_=FL_REASON_SELECTED; callback_(o, arg);}

  void do_callback(Fl_Widget* o,long arg) const {Fl::callback_reason_=FL_REASON_SELECTED; callback_(o, (void*)(fl_intptr_t)arg);}

  inline int checked() const {return value();}

  inline void check() {set();}

  inline void uncheck() {clear();}
 
  int insert(int,const char*,int,Fl_Callback*,void* =0, int =0);
  int add(const char*, int shortcut, Fl_Callback*, void* =0, int = 0);

  int add(const char*a, const char* b, Fl_Callback* c,
          void* d = 0, int e = 0) {
    return add(a,fl_old_shortcut(b),c,d,e);}
 
  int size() const ;
};
 
typedef Fl_Menu_Item Fl_Menu; // back compatibility
 
enum {  // back-compatibility enum:
  FL_PUP_NONE   = 0,
  FL_PUP_GREY   = FL_MENU_INACTIVE,
  FL_PUP_GRAY   = FL_MENU_INACTIVE,
  FL_MENU_BOX   = FL_MENU_TOGGLE,
  FL_PUP_BOX    = FL_MENU_TOGGLE,
  FL_MENU_CHECK = FL_MENU_VALUE,
  FL_PUP_CHECK  = FL_MENU_VALUE,
  FL_PUP_RADIO  = FL_MENU_RADIO,
  FL_PUP_INVISIBLE = FL_MENU_INVISIBLE,
  FL_PUP_SUBMENU = FL_SUBMENU_POINTER
};
 
#endif