cxSearchPanel.h

Go to the documentation of this file.

// Copyright (c) 2026 E. Oulashin
#ifndef __CXSEARCHPANEL_H__
#define __CXSEARCHPANEL_H__
 
// Copyright (c) 2006-2007 Michael H. Kinney
//
// This class is based on cxPanel, and it contains a cxForm at the
// top and a cxMenu below the form.
 
#include "cxPanel.h"
#include "cxForm.h"
#include "cxMenu.h"
#include <string>
#include <memory>
 
namespace cx {
 
class cxSearchPanel : public cxPanel
{
   public:
      explicit cxSearchPanel(cxWindow *pParentWindow = nullptr,
                       int pRow = 0, int pCol = 0,
                       int pHeight = DEFAULT_HEIGHT,
                       int pWidth = DEFAULT_WIDTH,
                       const std::string& pFormTitle = "",
                       const std::string& pMenuTitle = "",
                       eBorderStyle pFormBorderStyle = eBS_SINGLE_LINE,
                       eBorderStyle pMenuBorderStyle = eBS_SINGLE_LINE);
 
      cxSearchPanel(const cxSearchPanel& pPanel);
 
      virtual ~cxSearchPanel();
 
      const std::shared_ptr<cxForm>& getForm() const;
 
      const std::shared_ptr<cxMenu>& getMenu() const;
 
      virtual std::shared_ptr<cxMultiLineInput> appendToForm(int pRow, int pCol, int pHeight,
                                     int pWidth, const std::string& pLabel,
                                     const std::string& pValidator = "",
                                     const std::string& pHelpString = "",
                                     eInputOptions pInputKind = eINPUT_EDITABLE,
                                     const std::string& pName = "",
                                     std::string *pExtValue = nullptr);
 
      virtual std::shared_ptr<cxComboBox> appendComboBoxToForm(int pRow, int pCol, int pHeight,
                                     int pWidth, const std::string& pLabel,
                                     const std::string& pValidator = "",
                                     const std::string& pHelpString = "",
                                     eInputOptions pInputKind = eINPUT_EDITABLE,
                                     const std::string& pName = "",
                                     std::string *pExtValue = nullptr);
 
      virtual void appendToMenu(const std::string& pDisplayText, long pReturnCode,
                          const std::string& pHelpString = "",
                          const std::string& pItemText = "",
                          cxMenuItemType pType = cxITEM_NORMAL);
 
      virtual void appendToMenu(const std::string& pDisplayText, const std::string& pHelpString = "",
                                const std::string& pItemText = "",
                                cxMenuItemType pType = cxITEM_NORMAL);
 
      virtual void clearFormInputs(bool pRefresh = false, bool pOnlyEditable = false);
 
      virtual void clearMenu(bool pRefresh = false);
 
      void setFormOnFocusFunction(funcPtr4 pFuncPtr, void *p1, void *p2,
                           void *p3, void *p4, bool pUseVal = false,
                           bool pExitAfterRun = false);
 
      void setFormOnFocusFunction(funcPtr2 pFuncPtr, void *p1, void *p2,
                                  bool pUseVal = false,
                                  bool pExitAfterRun = false);
 
      void setFormOnFocusFunction(funcPtr0 pFuncPtr, bool pUseVal = false,
                                  bool pExitAfterRun = false);
 
      void setFormOnLeaveFunction(funcPtr4 pFuncPtr, void *p1, void *p2,
                                  void *p3, void *p4);
 
      void setFormOnLeaveFunction(funcPtr2 pFuncPtr, void *p1, void *p2);
 
      void setFormOnLeaveFunction(funcPtr0 pFuncPtr);
 
      virtual void setMenuOnFocusFunction(funcPtr4 pFunction, void *p1, void *p2,
                              void *p3, void *p4, bool pUseVal = false,
                              bool pExitAfterRun = false);
 
      virtual void setMenuOnFocusFunction(funcPtr2 pFunction, void *p1, void *p2,
                              bool pUseVal = false, bool pExitAfterRun = false);
 
      virtual void setMenuOnFocusFunction(funcPtr0 pFunction,
                             bool pUseVal = false, bool pExitAfterRun = false);
 
      virtual void setMenuOnLeaveFunction(funcPtr4 pFunction, void *p1, void *p2,
                              void *p3, void *p4);
 
      virtual void setMenuOnLeaveFunction(funcPtr2 pFunction, void *p1, void *p2);
 
      virtual void setMenuOnLeaveFunction(funcPtr0 pFunction);
 
      virtual void resize(int pNewHeight, int pNewWidth, bool pRefresh = true) override;
 
      virtual void setFormHeight(int pNewHeight, bool pRefresh = true);
 
      virtual void setMenuHeight(int pNewHeight, bool pRefresh = true);
 
      virtual std::string cxTypeStr() const override;
 
      virtual bool setFormOnEnterFunction(funcPtr4 pFunction, void *p1, void *p2,
                                          void *p3, void *p4);
 
      virtual bool setFormOnEnterFunction(funcPtr2 pFunction, void *p1, void *p2);
 
      virtual bool setFormOnEnterFunction(funcPtr0 pFunction);
 
      virtual void clearFormOnEnterFunction();
 
      virtual bool setFormKeyFunction(int pFunctionKey, funcPtr4 pFunction,
                                      void *p1, void *p2, void *p3, void *p4,
                                     bool pUseReturnVal = false,
                                     bool pExitAfterRun = false,
                                     bool pRunOnLeaveFunction = true);
 
      virtual bool setFormKeyFunction(int pFunctionKey, funcPtr2 pFunction,
                                      void *p1, void *p2,
                                      bool pUseReturnVal = false,
                                      bool pExitAfterRun = false,
                                      bool pRunOnLeaveFunction = true);
 
      virtual bool setFormKeyFunction(int pFunctionKey, funcPtr0 pFunction,
                                      bool pUseReturnVal = false,
                                      bool pExitAfterRun = false,
                                      bool pRunOnLeaveFunction = true);
 
      virtual void clearFormKeyFunction(int pFunctionKey);
 
      virtual void clearFormKeyFunctions();
 
      virtual bool formHasKeyFunction(int pFunctionKey) const;
 
      virtual bool setMenuKeyFunction(int pFunctionKey, funcPtr4 pFunction,
                                      void *p1, void *p2, void *p3, void *p4,
                                     bool pUseReturnVal = false,
                                     bool pExitAfterRun = false,
                                     bool pRunOnLeaveFunction = true);
 
      virtual bool setMenuKeyFunction(int pFunctionKey, funcPtr2 pFunction,
                                      void *p1, void *p2,
                                      bool pUseReturnVal = false,
                                      bool pExitAfterRun = false,
                                      bool pRunOnLeaveFunction = true);
 
      virtual bool setMenuKeyFunction(int pFunctionKey, funcPtr0 pFunction,
                                      bool pUseReturnVal = false,
                                      bool pExitAfterRun = false,
                                      bool pRunOnLeaveFunction = true);
 
      virtual void clearMenuKeyFunction(int pFunctionKey);
 
      virtual void clearMenuKeyFunctions();
 
      virtual bool menuHasKeyFunction(int pFunctionKey) const;
 
      virtual bool setMenuOnSelectItemFunction(funcPtr4 pFunction, void *p1,
                                               void *p2, void *p3, void *p4,
                                               bool pExitAfterRun,
                                               bool pRunOnLeaveFunction);
 
      virtual bool setMenuOnSelectItemFunction(funcPtr2 pFunction, void *p1,
                                               void *p2, bool pExitAfterRun,
                                               bool pRunOnLeaveFunction);
 
      virtual bool setMenuOnSelectItemFunction(funcPtr0 pFunction,
                                               bool pExitAfterRun,
                                               bool pRunOnLeaveFunction);
 
      virtual bool itemWasSelected() const;
 
      virtual std::string getSelectedItem(bool pDisplayText = true) const;
 
      virtual bool setFormCurrent();
 
      virtual bool setMenuCurrent();
 
   protected:
      void copyCxSearchPanelStuff(const cxSearchPanel* pThatPanel);
 
   private:
      std::shared_ptr<cxForm> mForm; // Pointer to the form on the panel
      std::shared_ptr<cxMenu> mMenu; // Pointer to the menu on the panel
 
      // This function is used when copying another cxSearchPanel.  It checks
      //  event function pointers (onFocus, onLeave, mFormOnEnterFunction) to
      //  see if any of their parameters point to another cxSearchPanel or its
      //  form or menu, and if so, has them point to this one or mForm or
      //  mMenu.
      //
      // Parameters:
      //  pPanel: Another cxSearchPanel being copied.  Its event function
      //   parameters will be checked when a cxSearchPanel is being copied.
      void checkEventFunctionPointers(const cxSearchPanel& pPanel);
 
      // Don't allow assignment with = (this causes segfaults)
      cxSearchPanel& operator =(const cxSearchPanel& pPanel);
 
      // This is an event function for when the user presses the up arrow or
      //  shift-tab in the cxForm.  If they are on the first input, it will go
      //  to the last input on the form.  Otherise, it will go to the previous
      //  input as usual.
      static std::string formReverseNavigation(void *theSearchPanel, void *unused);
 
      // This is an event function for when the user presses the ESCAPE in
      //  the cxMenu.  It will clear the form fields, the menu items, and
      //  apply focus to the first field on the form.
      static std::string menuOnESC(void *theSearchPanel, void *unused);
 
      // This is an event function for when the user selects an item in the
      //  menu.
      static std::string menuOnSelect(void *theSearchPanel, void *unused);
};
 
} // namespace cx
 
#endif