cxUtils.h

Go to the documentation of this file.

// Copyright (c) 2026 E. Oulashin
#ifndef __CXUTILS_H__
#define __CXUTILS_H__
 
/*
 * cxUtils.h - Contains cxWidgets utility functions.
 * For the library to work, you will need to put
 * "cx::init();" at the beginning of your program and
 * "cx::cleanup();" at the end of your program.
 * This does the screen initialization/cleanup.
 *
 * Copyright (c) 2005-2007 Michael H. Kinney
 *
 *
 * Date     User      Description
 * 08/21/07 erico     Added new versions of messageBox() that let you specify
 *                    colors for the different parts of the message box.  Also
 *                    added some default colors.
 */
 
 
#include "cxWindow.h"
#include "cxColors.h"
#include "cxInputOptions.h"
#include "cxInputTypes.h"
#include "cxWidgetsException.h" // Included here so that everything gets it
#include "cxMessageDialogStyles.h"
#include <string>
#include <set>
#include <list>
 
namespace cx
{
 
   void init(bool pEnableMouse = true);
 
   void cleanup();
 
   int top();
 
   int centerRow();
 
   int bottom();
 
   int left();
 
   int centerCol();
 
   int right();
 
   int width();
 
   int height();
 
   void getTermDimensions(int& pHeight, int& pWidth);
 
   bool resizeTerm(int pNewHeight, int pNewWidth);
 
   e_cxColors getDefaultMessageColor();
 
   void setDefaultMessageColor(e_cxColors pColor);
 
   e_cxColors getDefaultTitleColor();
 
   void setDefaultTitleColor(e_cxColors pColor);
 
   e_cxColors getDefaultStatusColor();
 
   void setDefaultStatusColor(e_cxColors pColor);
 
   e_cxColors getDefaultBorderColor();
 
   void setDefaultBorderColor(e_cxColors pColor);
 
   void messageBox(int pRow, int pCol, int pHeight, int pWidth, const std::string& pTitle,
                   const std::string& pMessage, const std::string& pStatus = "",
                   eBorderStyle pBorderStyle = eBS_SINGLE_LINE);
 
   void messageBox(int pRow, int pCol, const std::string& pTitle,
                   const std::string& pMessage, const std::string& pStatus);
 
   void messageBox(int pRow, int pCol, const std::string& pMessage);
 
   void messageBox(const std::string& pTitle, const std::string& pMessage,
                   const std::string& pStatus = "");
 
   void messageBox(const std::string& pTitle, const std::string& pMessage,
                   const std::string& pStatus, int pHeight, int pWidth);
 
 
   void messageBox(const std::string& pMessage, const std::string& pStatus, int pHeight, int pWidth);
 
   void messageBox(const std::string& pMessage,
                   e_cxColors pMessageColor = getDefaultMessageColor(),
                   attr_t pMessageAttr = A_NORMAL,
                   e_cxColors pTitleColor = getDefaultTitleColor(),
                   e_cxColors pStatusColor = getDefaultStatusColor(),
                   e_cxColors pBorderColor = getDefaultBorderColor());
 
   void messageDialog(const std::string& pMessage);
 
   void messageDialog(const std::list<std::string>& pMessages);
 
   void splash(const std::string& pTitle, const std::string& pMessage, int pSleep);
 
   void splash(const std::string& pMessage, int pSleep);
 
   void eraseScreen();
 
   void updateWindows();
 
   bool isFunctionKey(int pKey);
 
   bool toggleCursor(bool pToggleCursor);
 
   std::string getTermType();
 
   static const std::string termType = getTermType();
 
   bool colorIsBright(e_cxColors pColor);
 
   int countHotkeys(const std::string& pStr);
 
   std::string stringWithoutHotkeyChars(const std::string& pStr);
 
   unsigned visualStrLen(const std::string& pStr);
 
   std::string bringToTop(void* theWindow, void* unused);
 
   std::string cxFormShowModal(void* theForm, void* unused);
 
   std::string cxMenuShowModal(void* theMenu, void* unused);
 
   std::string noOp(void *p1, void *p2);
 
   std::string noOp(void *p1, void *p2, void *p3, void *p4);
 
   int runSystemCmd(const std::string& pCmd);
 
   void writeText(int pRow, int pCol, const std::string& pText, attr_t pAttr = A_NORMAL, e_cxColors pColor = eGRAY_BLACK);
 
   void getHotkeyChars(const std::string& pStr, std::set<char>& pHotkeys,
                       bool pConvertCase = false, bool pToUpper = false);
 
   void showAllWindows(bool pBringToTop = false);
 
   cxWindow* getTopWindow();
 
   cxWindow* getBottomWindow();
 
   std::string getKeyStr(int pKey);
 
   std::string getMouseStateStr(int pMouseState);
 
   std::string getReturnCodeStr(long pReturnCode);
 
   std::string getInputOptionStr(eInputOptions pInputOption);
 
   std::string getBorderStyleStr(eBorderStyle pBorderStyle);
 
   std::string getInputTypeStr(eInputTypes pInputType);
 
   void signalHandler(int pSignal);
 
   bool promptYesNo(const std::string& pMessage, const std::string& pTitle = "",
                    long pButtons = cxYES_NO);
 
   bool cxInitialized();
 
   void addAttr(e_WidgetItems pItem, attr_t pAttr);
 
   void setAttr(e_WidgetItems pItem, attr_t pAttr);
 
   void removeAttr(e_WidgetItems pItem, attr_t pAttr);
 
   void removeAttrs(e_WidgetItems pItem);
 
   void getAttrs(e_WidgetItems pItem, std::set<attr_t>& pAttrs);
 
 
   bool hasAttr(e_WidgetItems pItem, attr_t pAttr);
 
   void enableAttrs(WINDOW *pWindow, e_WidgetItems pItem);
 
   void disableAttrs(WINDOW *pWindow, e_WidgetItems pItem);
 
   attr_t getAttr(const std::string& pAttr);
 
   std::string getAttrStr(attr_t pAttr);
 
   std::string getWidgetItemStr(e_WidgetItems pItem);
 
   void setMenuClearKeywordKey(int pKey);
 
   int getMenuClearKeywordKey();
 
   std::string dump(bool pFancy=false, const std::string& pFilename="");
 
   bool isNavKey(int pKey);
 
   void addNavKey(int pKey);
 
   void removeNavKey(int pKey);
 
   std::string getString(int pRow, int pCol, int pNumber, WINDOW *pWin = nullptr);
 
   bool findString(const std::string& pSearch, int& pRow, int& pCol, WINDOW *pWin = nullptr);
 
} // namespace cx
 
#endif // __CXUTILS_H__