cxComboBox.h

Go to the documentation of this file.

// Copyright (c) 2026 E. Oulashin
#ifndef __CXCOMBOBOX_H__
#define __CXCOMBOBOX_H__
 
#include "cxMultiLineInput.h"
#include "cxMenu.h"
#include <string>
 
#include <set>
 
namespace cx {
 
using std::set;
 
class cxComboBox : public cxMultiLineInput
{
   public:
      explicit cxComboBox(cxWindow *pParentWindow = nullptr,
                       int pRow = 0, int pCol = 0,
                       int pHeight = DEFAULT_HEIGHT,
                       int pWidth = DEFAULT_WIDTH,
                       const std::string& pLabel = "",
                       eBorderStyle pBorderStyle = eBS_NOBORDER,
                       eInputOptions pInputOption = eINPUT_EDITABLE,
                       eInputTypes pInputType = eINPUT_TYPE_TEXT,
                       std::string *pExtValue = nullptr, bool pMenuEnabled = true,
                       int pRightLabelOffset = 0,
                       int pRightLabelHeight = 1,
                       int pRightLabelWidth = 5,
                       bool pShowRightLabel = false);
 
      // Copy constructor
      cxComboBox(const cxComboBox& pThatComboBox);
 
      virtual ~cxComboBox();
 
      virtual long showModal(bool pShowSelf = true, bool pBringToTop = true,
                             bool pShowSubwindows = true) override;
 
      virtual void resize(int pNewHeight, int pNewWidth, bool pRefresh = true) override;
 
      virtual bool move(int pNewRow, int pNewCol, bool pRefresh = true) override;
 
      virtual void erase(bool pEraseSubwindows = true) override;
 
      virtual void hide(bool pHideSubwindows = true) override;
 
      virtual void unhide(bool pUnhideSubwindows = true) override;
 
      virtual void appendToMenu(const std::string& pDisplayText,
                                const std::string& pItemText = "",
                                bool pRefresh = false, bool pBringToTop = false);
 
      virtual bool removeFromMenu(unsigned pItemIndex, bool pRefresh = false);
 
      virtual bool removeFromMenu(const std::string& pItemText,
                                  bool pDisplayText = true,
                                  bool pRefresh = false);
 
      virtual void removeAllItemsFromMenu();
 
      virtual void showMenu(bool pBringToTop = false);
 
      virtual void hideMenu();
 
      virtual unsigned numMenuItems() const;
 
      virtual std::string getItemText(int pIndex) const;
 
      virtual int height() const override;
 
      virtual int width() const override;
 
      virtual int inputHeight() const;
 
      virtual int inputWidth() const;
 
      virtual int menuHeight() const;
 
      virtual int menuWidth() const;
 
      virtual void setMenuHeight(int pNewHeight, bool pRefresh = false);
 
      virtual void toggleMenu(bool pEnableMenu, bool pRefresh = true);
 
      virtual bool menuIsEnabled() const;
 
      virtual std::string cxTypeStr() const override;
 
      cxMenu* getMenu();
 
      virtual void setDropDownKey(int pKey);
 
      virtual void addDropDownKey(int pKey);
 
      virtual void setDropDownKeys(const set<int>& pKeys);
 
      virtual void removeDropDownKey(int pKey);
 
      virtual bool hasDropDownKey(int pKey) const;
 
      virtual void toggleValidatorFunction(bool pRunValidatorFunction) override;
 
      virtual bool getUseValidatorFunction() const override;
 
      virtual void setUseAltMenuItemText(bool pUseAltMenuItemText);
 
      virtual bool getUseAltMenuItemText() const;
 
   protected:
      long doInputLoop(bool pShowSelf, bool& pRunOnLeaveFunction);
 
      void copyCxComboBoxStuff(const cxComboBox* pThatComboBox);
 
      bool menuIsModal() const;
 
   private:
      cxMenu mMenu;             // The drop-down menu
      bool mUseAltMenuItemText = false; // Whether or not to use the alternate text for menu items
      set<int> mDropDownKeys;   // Keys that show the drop-down menu
      // mRunValidatorFunction controls whether or not the validator function
      //  should run.  Note that cxMultiLineInput has this same bool too;
      //  however, cxComboBox will disable that one because cxComboBox will
      //  run the validator.
      bool mRunValidatorFunction = true;
 
      // This is a helper for doInputLoop().  This shows the drop-down menu if
      //  it's enabled.  This will return a return code to be used for the
      //  input loop and also set whether or not the input loop should
      //  continue.
      //
      // Parameters:
      //  pShowMenu: Whether or not to have the menu show its window when
      //   showModal() is called for it (for a screen optimization)
      //  pContinueOn (OUT): This will contain whether or not the input loop
      //   should continue.
      //
      // Return: The return code for use with the input loop & showModal()
      long showMenuModal(bool pShowMenu, bool& pContinueOn);
};
 
} // namespace cx
 
#endif