cxScrolledWindow.h

Go to the documentation of this file.

// Copyright (c) 2026 E. Oulashin
#ifndef __CXSCROLLEDWINDOW_H__
#define __CXSCROLLEDWINDOW_H__
// Copyright (c) 2005-2007 Michael H. Kinney
 
#include "cxWindow.h"
#include "cxFunction.h"
#include <string>
 
namespace cx {
 
#define DEFAULT_CXSCROLLEDWINDOW_SEARCH_KEY '/'     // Default search key
#define DEFAULT_CXSCROLLEDWINDOW_GOTO_KEY CTRL_G    // Default key to go to a line#
#define DEFAULT_CXSCROLLEDWINDOW_ALT_PGUP_KEY '.'   // Default alternate PgUp key
#define DEFAULT_CXSCROLLEDWINDOW_ALT_PGDOWN_KEY ',' // Default alternate PgDown key
 
class cxScrolledWindow : public cxWindow
{
   public:
      explicit cxScrolledWindow(cxWindow *pParentWindow = nullptr,
                        int pRow = 0, int pCol = 0,
                        int pHeight = DEFAULT_HEIGHT,
                        int pWidth = DEFAULT_WIDTH,
                        const std::string& pTitle = "",
                        const std::string& pMessage = "",
                        const std::string& pStatus = "",
                        eBorderStyle pBorderStyle = eBS_SINGLE_LINE,
                        cxWindow *pExtTitleWindow = nullptr,
                        cxWindow *pExtStatusWindow = nullptr,
                        bool pMessageUnderlines = false);
 
      cxScrolledWindow(cxWindow *pParentWindow,
               int pRow, int pCol, const std::string& pTitle,
               const std::string& pMessage, const std::string& pStatus,
               cxWindow *pExtTitleWindow = nullptr,
               cxWindow *pExtStatusWindow = nullptr,
               bool pMessageUnderlines = false);
 
      cxScrolledWindow(cxWindow *pParentWindow,
               const std::string& pTitle, const std::string& pMessage,
               const std::string& pStatus,
               cxWindow *pExtTitleWindow = nullptr,
               cxWindow *pExtStatusWindow = nullptr,
               bool pMessageUnderlines = false);
 
      cxScrolledWindow(cxWindow *pParentWindow,
               const std::string& pMessage, const std::string& pStatus,
               cxWindow *pExtTitleWindow = nullptr,
               cxWindow *pExtStatusWindow = nullptr,
               bool pMessageUnderlines = false);
 
      cxScrolledWindow(cxWindow *pParentWindow, const std::string& pMessage,
               cxWindow *pExtTitleWindow = nullptr,
               cxWindow *pExtStatusWindow = nullptr,
               bool pMessageUnderlines = false);
 
      cxScrolledWindow(cxWindow *pParentWindow, eHPosition pHPosition,
               const std::string& pTitle, const std::string& pMessage,
               const std::string& pStatus,
               cxWindow *pExtTitleWindow = nullptr,
               cxWindow *pExtStatusWindow = nullptr,
               bool pMessageUnderlines = false);
 
      cxScrolledWindow(const cxScrolledWindow& pThatWindow);
 
      virtual ~cxScrolledWindow();
 
      virtual long show(bool pBringToTop = true, bool pShowSubwindows = true) override;
 
      virtual long showModal(bool pShowSelf = true, bool pBringToTop = true,
                             bool pShowSubwindows = false) override;
 
      virtual void scrollWin(int pVertScrollAmt, int pHorizScrollAmt,
                          bool pRefresh = false);
 
      virtual void drawMessage() override;
 
      virtual bool move(int pNewRow, int pNewCol, bool pRefresh = true) override;
 
      virtual void resize(int pNewHeight, int pNewWidth, bool pRefresh = false) override;
 
      cxScrolledWindow& operator =(const cxScrolledWindow& pThatWindow);
 
      virtual void setSearchKey(int pKey);
 
      virtual void setGoToKey(int pKey);
 
      virtual void useLastKeyword(bool pUseLastKeyword);
 
      virtual void setAltPgUpKey(int pKey);
 
      virtual void setAltPgDownKey(int pKey);
 
      virtual void setLoopStartFunction(const std::shared_ptr<cxFunction>& pFuncPtr);
 
      virtual void setLoopEndFunction(const std::shared_ptr<cxFunction>& pFuncPtr);
 
      virtual std::string cxTypeStr() const override;
 
      virtual void drawBorder() override;
 
   protected:
      void reCreateSubWindow();
 
      virtual void init(int pRow, int pCol, int pHeight, int pWidth,
                        const std::string& pTitle, const std::string& pMessage,
                        const std::string& pStatus,
                        cxWindow *pParentWindow = nullptr,
                        bool pResizeVertically = false) override;
 
      void copyCxScrolledWindowStuff(const cxScrolledWindow* pThatWindow);
 
      int getLineNumber() const;
 
      int getSubWinHeight() const;
 
      int getSubWinWidth() const;
 
   private:
      WINDOW *mSubWindow = nullptr; // For scrolling
      int mSubWinHeight = 0;        // The height of the subwindow
      int mSubWinWidth = 0;         // The width of the subwindow
      int mLineNumber = 0;          // The topmost line# being shown from mMessageLines
      int mHScrollOffset = 0;       // Horizontal scrolling offset
      int mSearchKey = DEFAULT_CXSCROLLEDWINDOW_SEARCH_KEY;        // Key to use for searching
      int mGoToKey = DEFAULT_CXSCROLLEDWINDOW_GOTO_KEY;            // Key to use to go to a specific line#
      int mAltPgUpKey = DEFAULT_CXSCROLLEDWINDOW_ALT_PGUP_KEY;     // Alternate key for a pageUp
      int mAltPgDownKey = DEFAULT_CXSCROLLEDWINDOW_ALT_PGDOWN_KEY; // Alternate key for a pageDown
      std::string mSearchKeyword;   // Previous keyword used for searching
      bool mUseLastKeyword = true;  // Whether or not to use mSearchKeyword for searching
 
      // Functions to be run at various points in the input loop
      std::shared_ptr<cxFunction> mLoopStartFunction; // At the start of each cycle
      std::shared_ptr<cxFunction> mLoopEndFunction;   // At the end of each cycle
 
      // Handles the input loop.  Returns a return code based on the
      //  user's input.
      //
      // Parameters:
      //  pRunOnLeaveFunction (OUT): This will store whether or not the onLeave
      //   function should run.
      long doInputLoop(bool& pRunOnLeaveFunction);
 
      std::string getLine(int pLineNumber);
 
      // Scrolls to a specific line in mMessageLines.
      // Parameters:
      //  pLineNum: The line # to which to scroll (0-based)
      inline void goToLine(int pLineNum);
 
      // Prompts the user for a line number and scrolls to
      //  that line.
      void doGoToLine();
 
      // Prompts the user for a search keyword & scrolls to
      //  the line with that keyword.
      void doSearch();
 
      // Puts the horizontal scroll arrows in place on the bottom border.
      void drawHorizontalScrollArrows();
};
 
} // namespace cx
 
#endif