fltk/FL/Fl_Sys_Menu_Bar.H
Manolo Gouy f4e2292f80 Added some missing Doxygen comments in the Fl_Sys_Menu_Bar class.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10101 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2014-02-11 13:55:42 +00:00

82 lines
2.5 KiB
C++

//
// "$Id$"
//
// MacOS system menu bar header file for the Fast Light Tool Kit (FLTK).
//
// Copyright 1998-2010 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:
//
// http://www.fltk.org/COPYING.php
//
// Please report all bugs and problems on the following page:
//
// http://www.fltk.org/str.php
//
#ifndef Fl_Sys_Menu_Bar_H
#define Fl_Sys_Menu_Bar_H
#include "Fl_Menu_Bar.H"
#include "x.H"
#if defined(__APPLE__) || defined(FL_DOXYGEN)
/**
\brief A class to create, modify and delete menus that appear on Mac OS X in the menu bar at the top of the screen.
On other than Mac OS X platforms, Fl_Sys_Menu_Bar is a synonym of class Fl_Menu_Bar,
except for Fl_Sys_Menu_Bar::update() defined for Mac OS X only.
\n Some FLTK features are not supported by the Mac System menu:
\li no symbolic labels
\li no embossed labels
\li no font sizes
\li some calls of the parent class don't work
You can configure a callback for the 'About' menu item to invoke your own code with fl_mac_set_about().
*
*/
class FL_EXPORT Fl_Sys_Menu_Bar : public Fl_Menu_Bar {
protected:
void draw();
public:
Fl_Sys_Menu_Bar(int x,int y,int w,int h,const char *l=0);
~Fl_Sys_Menu_Bar();
/** Return the system menu's array of Fl_Menu_Item's */
const Fl_Menu_Item *menu() const {return Fl_Menu_::menu();}
void menu(const Fl_Menu_Item *m);
int add(const char* label, int shortcut, Fl_Callback*, void *user_data=0, int flags=0);
/** Adds a new menu item.
\see Fl_Menu_::add(const char* label, int shortcut, Fl_Callback*, void *user_data=0, int flags=0)
*/
int add(const char* label, const char* shortcut, Fl_Callback* cb, void *user_data=0, int flags=0) {
return add(label, fl_old_shortcut(shortcut), cb, user_data, flags);
}
int insert(int index, const char* label, int shortcut, Fl_Callback *cb, void *user_data=0, int flags=0);
void remove(int n);
void replace(int rank, const char *name);
void update();
/** Set the Fl_Menu_Item array pointer to null, indicating a zero-length menu.
\see Fl_Menu_::clear()
*/
void clear();
/** Clears the specified submenu pointed to by index of all menu items.
\see Fl_Menu_::clear_submenu(int index)
*/
int clear_submenu(int index);
};
#else
typedef Fl_Menu_Bar Fl_Sys_Menu_Bar;
#endif // defined(__APPLE__) || defined(FL_DOXYGEN)
#endif // Fl_Sys_Menu_Bar_H
//
// End of "$Id$".
//