StringItem Class Reference

#include <StringItem.h>

Public Member Functions
	StringItem (char *pszTitleANSI, wchar_t *pszTitleUnicode, char *pszCommand, char *pszInit, bool isSelected)
virtual	~StringItem ()
void	CreateEditWindow ()
void	DestroyEditWindow ()
void	Invoke (int button)
bool	Active (bool bActivate)
Public Member Functions inherited from MenuItem
	MenuItem (int type, char *pszTitleANSI, wchar_t *pszTitleUnicode, char *pszCommand, char *pszArgument, bool isSelected)
virtual	~MenuItem ()
virtual LRESULT	NcHitTest (int x, int y)
int	IsOver (int x, int y)
virtual void	Mouse (UINT nMsg, POINT pt)
virtual bool	IsActive ()
virtual char *	GetSortString ()
virtual void	GetItemRect (RECT *r)
virtual void	GetTitleRect (RECT *r)
virtual UINT	GetDrawTextFormat ()
virtual void	SetTitleANSI (char *pszTitleANSI)
virtual void	SetTitleUnicode (wchar_t *pszTitleUnicode)
void	AddToSelectionGroup (int group)
void	ItemSetTimer ()
virtual void	Timer (int nTimer)
void	ItemKillTimer ()
virtual void	SetWidth (int nWidth)
virtual int	GetWidth ()
virtual void	SetHeight (int nHeight)
virtual int	GetHeight ()
virtual void	SetPosition (int nLeft, int nTop)
virtual void	SetSortPriority (int nSortPriority)
virtual int	GetSortPriority ()
virtual void	Attached (Menu *pMenu)
virtual LRESULT	Command (WPARAM wParam, LPARAM lParam)
virtual bool	OnUser (int nMessage, WPARAM wParam, LPARAM lParam, LRESULT &lResult)
virtual void	Moving ()
virtual HWND	GetWindow ()
void	ToggleSelected ()

Public Attributes
char *	m_pszTitleANSI
wchar_t *	m_pszTitleUnicode
char *	m_pszCommand
char *	m_pszInit
HWND	m_hwndEditor
SIZE	buttonSize
bool	editboxActive
Public Attributes inherited from MenuItem
char *	m_pszTitleANSI
wchar_t *	m_pszTitleUnicode
int	itemType
char *	m_pszCommand
char *	m_pszArgument
char *	m_pszOriginalTitleANSI
wchar_t *	m_pszOriginalTitleUnicode
bool	m_isSelected
int	m_selectionGroup
int	m_currentValue
int	m_minValue
int	m_maxValue
POINT	m_mousePos
int	m_nSortPriority
Menu *	m_pParent
Menu *	m_pSubMenu
int	m_nLeft
int	m_nTop
int	m_nWidth
int	m_nHeight
bool	m_bActive
UINT	m_nTimerId
int	m_nLastMouseButton

Friends
LRESULT CALLBACK	EditWindowSubclassProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam, UINT_PTR uIdSubclass, DWORD_PTR dwRefData)

Additional Inherited Members
Static Public Member Functions inherited from MenuItem
static bool	Compare (MenuItem *pM1, MenuItem *pM2)

Constructor & Destructor Documentation

StringItem()

StringItem::StringItem	(	char *	pszTitleANSI,
		wchar_t *	pszTitleUnicode,
		char *	pszCommand,
		char *	pszInit,
		bool	isSelected )

                                                                                                                     : MenuItem(MENUITEM_EDITSTRING, pszTitleANSI, pszTitleUnicode, NULL, NULL, isSelected)
{
    m_pszTitleANSI = pszTitleANSI ? _strdup(pszTitleANSI) : _strdup("");
    m_pszTitleUnicode = pszTitleUnicode ? _wcsdup(pszTitleUnicode) : _wcsdup(L"");
    m_pszCommand = pszCommand ? _strdup(pszCommand) : _strdup("");
    m_pszInit = pszInit ? _strdup(pszInit) : _strdup("");
 
    m_hwndEditor = NULL;
 
    editboxActive = false;
}

~StringItem()

StringItem::~StringItem ( )

virtual

{
    DestroyEditWindow();
 
    if (m_pszTitleANSI) free(m_pszTitleANSI);
    m_pszTitleANSI = NULL;
    if (m_pszTitleUnicode) free(m_pszTitleUnicode);
    m_pszTitleUnicode = NULL;
    if (m_pszCommand) free(m_pszCommand);
    m_pszCommand = NULL;
    if (m_pszInit) free(m_pszInit);
    m_pszInit = NULL;
}

Member Function Documentation

CreateEditWindow()

void StringItem::CreateEditWindow

(

)

{
    if (!m_hwndEditor)
    {
        RECT workArea;
        ZeroMemory(&workArea, sizeof(workArea));
        SystemParametersInfo(SPI_GETWORKAREA, 0, &workArea, 0);
 
        int editboxWidth = (workArea.right - workArea.left) / 2;
        int editboxHeight = 15 * pSettings->scalingFactorHiDPI; // Using a regular DPI fixed font size of 15 pixels... (Segoe UI)
        editboxHeight += 12; // Add vertical padding to allow for a WS_EX_DLGMODALFRAME | WS_EX_CLIENTEDGE sunken double border (see extended window styles below)
        int editboxX = editboxWidth / 2;
        int editboxY = ((workArea.bottom - workArea.top) / 2) - (editboxHeight / 2);
 
        m_hwndEditor = CreateWindowEx(
            WS_EX_TOOLWINDOW | WS_EX_TOPMOST | WS_EX_DLGMODALFRAME | WS_EX_CLIENTEDGE,  // window style
            "EDIT",                                                                     // window class
            NULL,                                                                       // window name
            WS_POPUP | WS_BORDER | ES_LEFT | ES_AUTOHSCROLL,                            // window parameters
            editboxX,                                                                   // x position
            editboxY,                                                                   // y position
            editboxWidth,                                                               // window width
            editboxHeight,                                                              // window height
            m_pParent->GetWindow(),                                                        // parent window
            NULL,                                                                       // no menu
            m_pParent->hMenuInstance,                                                  // hInstance
            NULL                                                                        // no window creation data
        );
 
        if (!m_hwndEditor)
        {
            MessageBox(0, "Error creating menu string editor window!", "BBMenu", MB_OK | MB_ICONERROR | MB_TOPMOST);
            Log("Menu", "Error creating string editor window!");
            m_hwndEditor = NULL;
        }
        else
        {
            SendMessage(m_hwndEditor, (UINT)WM_SETFONT, (WPARAM)pMenuCommon->m_hEditStringFont, TRUE);
            SendMessage(m_hwndEditor, (UINT)EM_SETLIMITTEXT, (WPARAM)255, 0); // Allow maximum 255 characters in the edit control
            SendMessage(m_hwndEditor, WM_SETTEXT, 0, (LPARAM)m_pszInit);
            SendMessage(m_hwndEditor, EM_SETSEL, (WPARAM)0, (LPARAM)-1); // Select all text in the edit control
 
            // Add a subclass to the edit window to be able to respond to the Enter key (not visible to the parent WndProc) being pressed...
            SetWindowSubclass(m_hwndEditor, EditWindowSubclassProc, 0, 0);
 
            ShowWindow(m_hwndEditor, SW_SHOW);
            SetWindowPos(m_hwndEditor, HWND_TOPMOST, 0, 0, 0, 0, SWP_NOACTIVATE | SWP_NOSIZE | SWP_NOMOVE);
            SetForegroundWindow(m_hwndEditor);
        }
    }
}

DestroyEditWindow()

void StringItem::DestroyEditWindow

(

)

{
    if (m_hwndEditor)
    {
        pSettings->menuEditboxAlreadyActive = false;
        editboxActive = false;
        ShowWindow(m_hwndEditor, SW_HIDE);
        RemoveWindowSubclass(m_hwndEditor, EditWindowSubclassProc, 0);
        DestroyWindow(m_hwndEditor);
        m_hwndEditor = NULL;
    }
}

Invoke()

void StringItem::Invoke ( int button )

virtual

Reimplemented from MenuItem.

{
    if ((button == 1) && !editboxActive)
    {
        // Execute the broam command+parameters associated with the StringItem, without prior editing...
        // (cf. e.g. a browser bookmark menu item scenario -> Open/execute (left click) or edit (right click) the bookmark via a single menu item)
        pMenuCommon->Invoke(this, 1);
        return;
    }
 
    //====================
 
    else if (editboxActive)
    {
        pSettings->menuEditboxAlreadyActive = false;
        editboxActive = false;
        pSettings->menuEditboxStringItemPtr = NULL;
 
        // Fetch the newly edited string from the edit box...
        char editedValue[255];
        SendMessage(m_hwndEditor, WM_GETTEXT, 255, (LPARAM)&editedValue);
        editedValue[sizeof(editedValue)-1] = '\0'; // Failsafe
 
        // Update the menu item title as applicable...
 
        if ((strlen(m_pszTitleANSI) >= 3) && !_strnicmp(&m_pszTitleANSI[strlen(m_pszTitleANSI)-3], "...", 3))
        {
            // Hidden init string -> Nothing to do here... (for now at least?)
        }
        else // Visible init string...
        {
            if (strlen(m_pszInit) > 0) // -> Prior init string existed -> Replace it with the newly edited one...
            {
                char* ptr1 = strstr(m_pszTitleANSI, m_pszInit);
                if (ptr1 != NULL)
                {
                    char* ptr0 = &m_pszTitleANSI[0];
                    char* ptr2 = ptr1 + strlen(m_pszInit);
 
                    char newTitle[MAX_LINE_LENGTH];
//                  strncpy(newTitle, m_pszTitleANSI, (int)(ptr1-ptr0));
                    strncpy_s(newTitle, sizeof(newTitle), m_pszTitleANSI, (int)(ptr1-ptr0));
                    newTitle[(int)(ptr1-ptr0)] = '\0';
                    if (strlen(editedValue) > 0) strcat(newTitle, editedValue);
                    strcat(newTitle, ptr2);
                    newTitle[sizeof(newTitle)-1] = '\0'; // Failsafe
 
//                  if (pSettings->debugLogging) SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_INFORMATION_MESSAGE, (LPARAM)newTitle);
 
                    if (m_pszTitleANSI) free(m_pszTitleANSI);
                    m_pszTitleANSI = newTitle ? _strdup(newTitle) : _strdup("");
 
                    if (m_pszTitleUnicode) free(m_pszTitleUnicode);
                    wchar_t newTitleUnicode[MAX_LINE_LENGTH];
                    MultiByteToWideChar(CP_UTF8, 0, newTitle, strlen(newTitle)+1, newTitleUnicode, MAX_LINE_LENGTH);
                    m_pszTitleUnicode = newTitleUnicode ? _wcsdup(newTitleUnicode) : _wcsdup(L"");
                }
            }
            else // -> No prior init string existed -> Look for the default edit string <> brackets and insert the newly edited string in between them...
            {
                if (strlen(editedValue) > 0)
                {
                    char* ptr0 = &m_pszTitleANSI[0];
                    char* ptr1 = strstr(m_pszTitleANSI, "<>");
                    if (ptr1 != NULL)
                    {
                        char newTitle[MAX_LINE_LENGTH];
//                      strncpy(newTitle, m_pszTitleANSI, (int)(ptr1-ptr0)+1);
                        strncpy_s(newTitle, sizeof(newTitle), m_pszTitleANSI, (int)(ptr1-ptr0)+1);
                        newTitle[(int)(ptr1-ptr0)+1] = '\0';
                        if (strlen(editedValue) > 0) strcat(newTitle, editedValue);
                        strcat(newTitle, ptr1+1);
                        newTitle[sizeof(newTitle)-1] = '\0'; // Failsafe
 
//                      if (pSettings->debugLogging) SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_INFORMATION_MESSAGE, (LPARAM)newTitle);
 
                        if (m_pszTitleANSI) free(m_pszTitleANSI);
                        m_pszTitleANSI = newTitle ? _strdup(newTitle) : _strdup("");
 
                        if (m_pszTitleUnicode) free(m_pszTitleUnicode);
                        wchar_t newTitleUnicode[MAX_LINE_LENGTH];
                        MultiByteToWideChar(CP_UTF8, 0, newTitle, strlen(newTitle)+1, newTitleUnicode, MAX_LINE_LENGTH);
                        m_pszTitleUnicode = newTitleUnicode ? _wcsdup(newTitleUnicode) : _wcsdup(L"");
                    }
                }
            }
 
            MenuItem::SetTitleANSI(m_pszTitleANSI);
            MenuItem::SetTitleUnicode(m_pszTitleUnicode);
        }
 
        // Save the newly edited string as the new menu item init string...
        if (m_pszInit) free(m_pszInit);
        m_pszInit = editedValue ? _strdup(editedValue) : _strdup("");
 
        // Set the menu item as selected if so applicable...
        if (m_selectionGroup > GROUP_DEFAULT)
        {
            m_pParent->ClearSelectionGroup(m_selectionGroup);
            m_isSelected = true;
        }
 
        //====================
 
        // Send the broam command associated with the StringItem...
        char broam[MAX_LINE_LENGTH];
 
        if (IsInString(m_pszCommand, "@BBInterface"))
        {
            // Add "" encapsulation to the broam parameters string to
            // allow spaces in strings sent back to BBInterface...
            int nLen = strlen(editedValue);
            memmove(editedValue+1, editedValue, strlen(editedValue));
            editedValue[0] = editedValue[nLen+1] = '\"';
            editedValue[nLen+2] = '\0';
 
//          SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_INFORMATION_MESSAGE, (LPARAM)"StringItem::Invoke() broadcasting back...");
//          SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_INDENTED_MESSAGE, (LPARAM)m_pszCommand);
//          SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_INDENTED_MESSAGE, (LPARAM)editedValue);
        }
 
        sprintf(broam, "%s %s", m_pszCommand, editedValue);
//      SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_INDENTED_MESSAGE, (LPARAM)broam);
        SendMessage(GetBBWnd(), BB_BROADCAST, 0, (LPARAM)broam);
 
        //====================
 
        // Hide the editor window...
        DestroyEditWindow();
        SetWindowPos(m_pParent->GetWindow(), HWND_TOPMOST, 0, 0, 0, 0, SWP_NOSIZE | SWP_NOMOVE | SWP_NOACTIVATE | SWP_NOSENDCHANGING);
 
        // Update the menu...
        m_pParent->Invalidate();
        m_pParent->Validate();
        m_pParent->UpdateMenuWindow();
    }
 
    //====================
 
    else
    {
        // Allow only a single menu item editbox to be active at a time...
        if (!editboxActive && !pSettings->menuEditboxAlreadyActive && (pSettings->menuEditboxStringItemPtr == NULL))
        {
            // Show the editor window and "OK?" button...
            pSettings->menuEditboxAlreadyActive = true;
            editboxActive = true;
            pSettings->menuEditboxStringItemPtr = this;
            SetWindowPos(m_pParent->GetWindow(), HWND_NOTOPMOST, 0, 0, 0, 0, SWP_NOSIZE | SWP_NOMOVE | SWP_NOACTIVATE | SWP_NOSENDCHANGING);
            CreateEditWindow();
        }
        else if (pSettings->menuEditboxStringItemPtr != NULL)
        {
            // Hide the editor window belonging to another menu item...
            StringItem* si = (StringItem*)pSettings->menuEditboxStringItemPtr;
            si->DestroyEditWindow();
            si->editboxActive = false;
            pSettings->menuEditboxStringItemPtr = NULL;
            pSettings->menuEditboxAlreadyActive = false;
            SetWindowPos(m_pParent->GetWindow(), HWND_TOPMOST, 0, 0, 0, 0, SWP_NOSIZE | SWP_NOMOVE | SWP_NOACTIVATE | SWP_NOSENDCHANGING);
        }
 
        // Update the menu...
        m_pParent->Invalidate();
        m_pParent->Validate();
        m_pParent->UpdateMenuWindow();
    }
}

Active()

bool StringItem::Active ( bool bActivate )

virtual

Reimplemented from MenuItem.

{
    if (editboxActive) return false;
    else return MenuItem::Active(bActivate);
}

Friends And Related Symbol Documentation

EditWindowSubclassProc

LRESULT CALLBACK EditWindowSubclassProc ( HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam, UINT_PTR uIdSubclass, DWORD_PTR dwRefData )

friend

{
    if (pSettings->menuEditboxStringItemPtr != NULL)
    {
        if (message == WM_KEYDOWN)
        {
            if (wParam == VK_RETURN)
            {
                // Pressing the return key -> Same action as *right* clicking the "OK" button, i.e. invoke action + keep the menu open...
                pSettings->menuEditboxStringItemPtr->Invoke(2);
            }
            else if (wParam == VK_ESCAPE)
            {
                // Pressing the escape key -> Hide the editor window *without* invoking any action, i.e. discard any edits + keep the menu open...
                StringItem* si = (StringItem*)pSettings->menuEditboxStringItemPtr;
                si->DestroyEditWindow();
                si->editboxActive = false;
                pSettings->menuEditboxStringItemPtr = NULL;
                pSettings->menuEditboxAlreadyActive = false;
 
                si->m_pParent->Invalidate();
                si->m_pParent->Validate();
                si->m_pParent->UpdateMenuWindow();
            }
        }
    }
 
    return DefSubclassProc(hwnd, message, wParam, lParam);
}

Member Data Documentation

m_pszTitleANSI

char* StringItem::m_pszTitleANSI

m_pszTitleUnicode

wchar_t* StringItem::m_pszTitleUnicode

m_pszCommand

char* StringItem::m_pszCommand

m_pszInit

char* StringItem::m_pszInit

m_hwndEditor

HWND StringItem::m_hwndEditor

buttonSize

SIZE StringItem::buttonSize

editboxActive

bool StringItem::editboxActive