cxMenuBar.h

Go to the documentation of this file.

// Copyright (c) 2026 E. Oulashin
#ifndef __CXMENUBAR_H__
#define __CXMENUBAR_H__
 
// cxMenuBar: A horizontal menu bar derived from cxWindow.
// Displays menu items horizontally across a single row at the top of the
// screen. Each item can have an associated cxMenu that drops down when
// the item is selected. Navigation is via left/right arrow keys, Enter
// to open a menu, and ESC to close.
//
// Usage:
//   cxMenuBar menuBar(nullptr, 0, 0, termWidth);
//   cxMenu fileMenu(...);
//   fileMenu.append("&Open", 1, "", cxITEM_NORMAL, true);
//   menuBar.addMenu("&File", &fileMenu);
//   menuBar.addMenu("&Help", &helpMenu);
//   long result = menuBar.showModal();
 
#include "cxWindow.h"
#include "cxMenu.h"
#include "cxFunction.h"
#include <string>
#include <vector>
#include <memory>
#include <map>
 
namespace cx {
 
class cxMenuBar : public cxWindow
{
   public:
 
      explicit cxMenuBar(cxWindow *pParentWindow = nullptr,
                         int pRow = 0, int pCol = 0,
                         int pWidth = DEFAULT_WIDTH,
                         eBorderStyle pBorderStyle = eBS_NOBORDER);
 
      cxMenuBar(const cxMenuBar& pThat);
 
      virtual ~cxMenuBar();
 
      // Overridden virtual functions from cxWindow
 
      virtual long show(bool pBringToTop = false, bool pShowSubwindows = true) override;
      virtual long showModal(bool pShowSelf = true, bool pBringToTop = true,
                             bool pShowSubwindows = true) override;
      virtual bool modalGetsKeypress() const override;
      virtual void draw() override;
      virtual void hide(bool pHideSubwindows = true) override;
      virtual void unhide(bool pUnhideSubwindows = true) override;
      virtual void erase(bool pEraseSubwindows = true) override;
      virtual bool move(int pNewRow, int pNewCol, bool pRefresh = true) override;
      virtual void resize(int pNewHeight, int pNewWidth, bool pRefresh = true) override;
      virtual void clear(bool pRefresh = false) override;
      virtual void bringToTop(bool pRefresh = true) override;
      virtual bool hasFocus() const override;
      virtual void setColor(e_WidgetItems pItem, e_cxColors pColor) override;
      virtual void setBorderStyle(eBorderStyle pBorderStyle) override;
      virtual void setLastKey(int pLastKey) override;
      virtual void quitNow() override;
      virtual void exitNow() override;
      virtual bool setKeyFunction(int pKey, const std::shared_ptr<cxFunction>& pFunction) override;
      virtual void clearKeyFunction(int pKey) override;
      virtual void clearKeyFunctions() override;
      virtual void removeQuitKey(int pKey) override;
      virtual void removeExitKey(int pKey) override;
      virtual void setEnabled(bool pEnabled) override;
      virtual void setDisableCursorOnShow(bool pDisableCursorOnShow) override;
      virtual std::string cxTypeStr() const override;
      virtual cxWindow* getParent() const override;
      virtual void addAttr(e_WidgetItems pItem, attr_t pAttr) override;
      virtual void setAttr(e_WidgetItems pItem, attr_t pAttr) override;
      virtual void removeAttr(e_WidgetItems pItem, attr_t pAttr) override;
      virtual void removeAttrs(e_WidgetItems pItem) override;
      virtual void getAttrs(e_WidgetItems pItem, std::set<attr_t>& pAttrs) const override;
      virtual void enableAttrs(WINDOW *pWin, e_WidgetItems pItem) override;
      virtual void disableAttrs(WINDOW *pWin, e_WidgetItems pItem) override;
      virtual e_cxColors getItemColor(e_WidgetItems pItem) const override;
 
      // MenuBar-specific functions
 
      void addMenu(const std::string& pLabel, cxMenu* pMenu);
 
      int numMenus() const;
 
      int getCurrentIndex() const;
 
      void setCurrentIndex(int pIndex);
 
      std::string getMenuLabel(int pIndex) const;
 
      long showModalWithClick(int pClickX, bool pShowSelf = true,
                              bool pBringToTop = true,
                              bool pShowSubwindows = true);
 
      void setMenuHotkey(int pKey, int pMenuIndex);
 
      long getLastMenuReturnCode() const;
 
      void setBarColor(e_cxColors pColor);
 
      void setHighlightColor(e_cxColors pColor);
 
   private:
 
      // A menu bar entry: label + pointer to the dropdown menu
      struct MenuEntry
      {
         std::string label;       // Display label (with & hotkey markers)
         std::string cleanLabel;  // Label without hotkey chars
         char hotkeyChar;         // The hotkey character (lowercase), or '\0'
         cxMenu* menu;            // Pointer to the dropdown menu (not owned)
         int xPos;                // X position of this label in the bar
      };
 
      std::vector<MenuEntry> mEntries;
 
      // Currently highlighted menu index
      int mCurrentIndex;
 
      // Return code from the last dropdown menu selection
      long mLastMenuReturnCode;
 
      // Hotkeys that map to menu indices
      std::map<int, int> mMenuHotkeys;
 
      // Colors
      short mBarColorPair;
      short mHighlightColorPair;
 
      // Whether the bar currently has focus
      bool mHasFocus;
 
      // Helper: draw the bar contents
      void drawBar();
 
      // Helper: open the dropdown menu for the current index
      // Returns the return code from the dropdown menu
      long openDropdown(int pIndex);
 
      // Helper: the main input loop
      long inputLoop();
};
 
} // namespace cx
 
#endif // __CXMENUBAR_H__