Workspaces Class Reference

#include <Workspaces.h>

Public Types
typedef vector< string >	WorkspaceNamesVector
typedef vector< string >	StickyListVector

Public Member Functions
	Workspaces (HINSTANCE hMainInstance)
	~Workspaces ()
void	PreviousWorkspace ()
void	NextWorkspace ()
void	LastWorkspace ()
void	SwitchToWorkspace (int workspace)
void	NewWorkspace ()
void	RemoveLastWorkspace ()
void	UpdateWorkspaceNames ()
int	GetWorkspaceByWindow (HWND window)
int	GetWorkspaceByRect (RECT r)
void	GatherWindows ()
void	MoveWindowToWorkspace (HWND window, int workspace)
void	MoveWindowToPreviousWorkspace (HWND window)
void	MoveWindowToNextWorkspace (HWND window)

Public Attributes
HINSTANCE	hWorkspacesInstance
HWND	hWorkspacesWnd
WorkspaceNamesVector	workspaceNames
StickyListVector	stickyList
int	ScreenWidth
int	ScreenHeight
HDWP	dwp

Friends
LRESULT CALLBACK	WndProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
BOOL CALLBACK	EnumWindowsProc (HWND hwnd, LPARAM lParam)

Member Typedef Documentation

WorkspaceNamesVector

typedef vector<string> Workspaces::WorkspaceNamesVector

StickyListVector

typedef vector<string> Workspaces::StickyListVector

Constructor & Destructor Documentation

Workspaces()

Workspaces::Workspaces

(

HINSTANCE

hMainInstance

)

{
    hWorkspacesInstance = hMainInstance;
 
    ScreenWidth = GetSystemMetrics(SM_CXVIRTUALSCREEN);
    ScreenHeight = GetSystemMetrics(SM_CYVIRTUALSCREEN);
 
    UpdateWorkspaceNames();
 
    //====================
 
    // Register window class...
    WNDCLASS wc;
    ZeroMemory(&wc,sizeof(wc));
    wc.hInstance = hWorkspacesInstance;      
    wc.lpfnWndProc = WndProc;                // Window procedure
    wc.lpszClassName = szWorkspacesName;    // Window class name
 
    if (!RegisterClass(&wc))
    {
        MessageBox(0, "Error registering workspaces window class!", szWorkspacesName, MB_OK);
        Log("Workspaces", "Error registering window class!");
        return;
    }
 
    // Create workspaces handling window...
    hWorkspacesWnd = CreateWindowEx(
        WS_EX_TOOLWINDOW | WS_EX_NOACTIVATE,    // window style
        szWorkspacesName,                       // window class
        NULL,                                   // window name
        0,                                      // window parameters
        0,                                      // x position
        0,                                      // y position
        0,                                      // window width
        0,                                      // window height
        GetBBWnd(),                             // owner window
        NULL,                                   // no menu
        hWorkspacesInstance,                 // hInstance
        NULL                                    // no window creation data
    );
 
    if (!hWorkspacesWnd)
    {                          
        UnregisterClass(szWorkspacesName, hWorkspacesInstance); // Unregister window class
        MessageBox(0, "Error creating workspaces window!", szWorkspacesName, MB_OK);
        Log("Workspaces", "Error creating window!");
        return;
    }
 
    //====================
 
    // Subscribe to Blackbox messages applicable to workspaces handling...
    SendMessage(GetBBWnd(), BB_REGISTERMESSAGE, (WPARAM)hWorkspacesWnd, (LPARAM)workspacesMessageSubscription);
 
    MakeSticky(hWorkspacesWnd);     
}

~Workspaces()

Workspaces::~Workspaces

(

)

{
    GatherWindows();
 
    // Unsubscribe to previously subscribed Blackbox messages...
    SendMessage(GetBBWnd(), BB_UNREGISTERMESSAGE, (WPARAM)hWorkspacesWnd, (LPARAM)workspacesMessageSubscription);
 
    DestroyWindow(hWorkspacesWnd); // Destroy window...
    UnregisterClass(szWorkspacesName, hWorkspacesInstance); // Unregister window class...
 
    workspaceNames.clear();
}

Member Function Documentation

PreviousWorkspace()

void Workspaces::PreviousWorkspace

(

)

{
    int workspace;
    if (pSettings->currentWorkspace > 0) workspace = pSettings->currentWorkspace - 1;
    else workspace = pSettings->numberOfWorkspaces - 1;
    SwitchToWorkspace(workspace);
}

NextWorkspace()

void Workspaces::NextWorkspace

(

)

{
    int workspace;
    if (pSettings->currentWorkspace < (pSettings->numberOfWorkspaces - 1)) workspace = pSettings->currentWorkspace + 1;
    else workspace = 0;
    SwitchToWorkspace(workspace);
}

LastWorkspace()

void Workspaces::LastWorkspace

(

)

{   
    SwitchToWorkspace(pSettings->lastWorkspace);
}

SwitchToWorkspace()

void Workspaces::SwitchToWorkspace

(

int

workspace

)

{
    if ((workspace != pSettings->currentWorkspace) && (workspace >= 0) && (workspace < pSettings->numberOfWorkspaces))
    {
        int addH = ((workspace % pSettings->numberOfWorkspaces) - (pSettings->currentWorkspace % pSettings->numberOfWorkspaces)) * (ScreenWidth + 10);
 
        dwp = BeginDeferWindowPos(0);
        EnumWindows(EnumWindowsProc, (LPARAM)addH);
        EndDeferWindowPos(dwp);
 
        pSettings->lastWorkspace = pSettings->currentWorkspace;
        pSettings->currentWorkspace = workspace;
 
        PlaySoundFX(SFX_WORKSPACE_CHANGE);
        pDesktop->UpdateDesktopWindow();
 
        if (pSettings->wallpaperPerWorkspace)
        {
            pSettings->wallpaperPerWorkspaceSemaphore = true;
            _beginthread(ExecuteRootCommand, 0, NULL);
        }
 
        if (!pSettings->accessLock)
        {
            // Update the toolbar... (including workspace label, taskbar if applicable, etc)
            if (pToolbar) pToolbar->UpdatePosition();
        }
    }
}

NewWorkspace()

void Workspaces::NewWorkspace

(

)

{
    // Note:
    // "Workspace 254" is used as a wildcard to e.g. list tasks on all workspaces
    // "Workspace 255" is used for minimized tasks
    if (pSettings->numberOfWorkspaces == 253) return; // -> We've reached the theoretical maximum number of workspaces... ;)
 
    pSettings->numberOfWorkspaces++;
    UpdateWorkspaceNames();
 
    if (pTaskbar)
    {
        if (pSettings->taskbarMode != TASKBAR_MODE_HIDDEN) pTaskbar->cachedTaskButtonsExist = false;
    }
    if (pToolbar)
    {
        // Update the toolbar... (including workspace label, taskbar if applicable, etc)
        pToolbar->cachedBitmapsExist = false;
        pToolbar->UpdatePosition();
    }
    if (pDesktop) pDesktop->UpdateDesktopWindow(); // Update the number of workspace indicators on the desktop...
 
    WriteInt(pSettings->xobrcDefaultFile, "xoblite.workspaces:", pSettings->numberOfWorkspaces);
}

RemoveLastWorkspace()

void Workspaces::RemoveLastWorkspace

(

)

{
    if (pSettings->numberOfWorkspaces != 1)
    {
        if (pSettings->currentWorkspace == pSettings->numberOfWorkspaces - 1)
        {
            SwitchToWorkspace(pSettings->currentWorkspace-1);
        }
 
        pSettings->numberOfWorkspaces--;
        UpdateWorkspaceNames();
 
        if (pTaskbar)
        {
            for (int i = 0; i < (int)pTaskbar->taskList.size(); i++)
            {
                if (!CheckSticky(pTaskbar->taskList[i]->hwnd))
                {
                    if (pTaskbar->taskList[i]->workspace > (pSettings->numberOfWorkspaces - 1)) pTaskbar->taskList[i]->workspace = pSettings->numberOfWorkspaces - 1;
                }
            }
 
            if (pSettings->taskbarMode != TASKBAR_MODE_HIDDEN) pTaskbar->cachedTaskButtonsExist = false;
        }
        if (pToolbar)
        {
            // Update the toolbar... (including workspace label, taskbar if applicable, etc)
            pToolbar->cachedBitmapsExist = false;
            pToolbar->UpdatePosition();
        }
        if (pDesktop) pDesktop->UpdateDesktopWindow(); // Update the number of workspace indicators on the desktop...
    }
 
    WriteInt(pSettings->xobrcDefaultFile, "xoblite.workspaces:", pSettings->numberOfWorkspaces);
}

UpdateWorkspaceNames()

void Workspaces::UpdateWorkspaceNames

(

)

{
    workspaceNames.clear();
    char buffer[MAX_LINE_LENGTH], szBuffer[MAX_PATH];
    strcpy(buffer, pSettings->workspaceNames);
 
    for (int i = 0; i < pSettings->numberOfWorkspaces; i++)
    {
        strcpy(buffer, Tokenize(buffer, szBuffer, ","));
        if (!strcmp(szBuffer,"")) sprintf(szBuffer, "Workspace #%d", i+1); // -> Default if no name configured
        workspaceNames.push_back(string(szBuffer));
    }
}

GetWorkspaceByWindow()

int Workspaces::GetWorkspaceByWindow

(

HWND

window

)

{
    if (!window || IsIconic(window)) return 255;
 
    if (pTaskbar)
    {
        int i = pTaskbar->FindTask(window);
        if (i >= 0) return pTaskbar->taskList[i]->workspace;
    }
 
    // Use legacy GetWorkspaceByRect() based mechanism as fallback... (see below)
    RECT r;
    GetWindowRect(window, &r);
    return (GetWorkspaceByRect(r));
}

GetWorkspaceByRect()

int Workspaces::GetWorkspaceByRect

(

RECT

r

)

{
    int offsetX = pSettings->currentWorkspace % pSettings->numberOfWorkspaces;
    int offsetY = pSettings->currentWorkspace / pSettings->numberOfWorkspaces;
    int workspace;
    RECT tempRect, workspaceRect;
 
    workspaceRect.left = workspaceRect.top = 0;
    workspaceRect.right = ScreenWidth;
    workspaceRect.bottom = ScreenHeight;
 
    if (IntersectRect(&tempRect, &r, &workspaceRect)) return pSettings->currentWorkspace;
 
    r.left += offsetX * (ScreenWidth + 10);
    r.top += offsetY * (ScreenHeight + 10);
 
    offsetX = ((r.left + 10) / (ScreenWidth + 10));
    offsetY = ((r.top + 10) / (ScreenHeight + 10));
 
    workspace = (offsetY * pSettings->numberOfWorkspaces) + offsetX;
 
    if (workspace < 0 || workspace > pSettings->numberOfWorkspaces) workspace = pSettings->currentWorkspace;
 
    return workspace;
}

GatherWindows()

void Workspaces::GatherWindows

(

)

{
    dwp = BeginDeferWindowPos(0);
    EnumWindows(EnumWindowsProc, (LPARAM)-1);
    EndDeferWindowPos(dwp);
 
    if (pTaskbar)
    {
        for (int i = 0; i < (int)pTaskbar->taskList.size(); i++)
        {
            if (!CheckSticky(pTaskbar->taskList[i]->hwnd)) pTaskbar->taskList[i]->workspace = pSettings->currentWorkspace;
        }
    }
 
    if (!pSettings->accessLock)
    {
        // Update the toolbar... (including workspace label, taskbar if applicable, etc)
        if (pToolbar) pToolbar->UpdatePosition();
    }
}

MoveWindowToWorkspace()

void Workspaces::MoveWindowToWorkspace	(	HWND	window,
		int	workspace )

{
    if (CheckSticky(window)) return;
    if ((workspace < 0) || (workspace >= pSettings->numberOfWorkspaces)) return;
 
    SwitchToWorkspace(GetWorkspaceByWindow(window));
//  BBSwitchToThisWindow(window, FALSE);
    BringWindowToTop(window);
 
    MakeSticky(window);
    SwitchToWorkspace(workspace);
    RemoveSticky(window);
 
    if (pTaskbar)
    {
        int i = pTaskbar->FindTask(window);
        if (i >= 0) pTaskbar->taskList[i]->workspace = workspace;
    }
 
    if (!pSettings->accessLock)
    {
        // Do we need to update the toolbar?
        if ((pSettings->taskbarMode != TASKBAR_MODE_HIDDEN) && pSettings->taskbarCurrentOnly && pToolbar)
        {
            pTaskbar->cachedTaskButtonsExist = false;
            if (pToolbar) pToolbar->UpdatePosition();
        }
    }
}

MoveWindowToPreviousWorkspace()

void Workspaces::MoveWindowToPreviousWorkspace

(

HWND

window

)

{
    int workspace;
    if (pSettings->currentWorkspace == 0) workspace = pSettings->numberOfWorkspaces - 1;
    else workspace = pSettings->currentWorkspace - 1;
    MoveWindowToWorkspace(window, workspace);
}

MoveWindowToNextWorkspace()

void Workspaces::MoveWindowToNextWorkspace

(

HWND

window

)

{
    int workspace;
    if (pSettings->currentWorkspace == (pSettings->numberOfWorkspaces - 1)) workspace = 0;
    else workspace = pSettings->currentWorkspace + 1;
    MoveWindowToWorkspace(window, workspace);
}

Friends And Related Symbol Documentation

WndProc

LRESULT CALLBACK WndProc ( HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam )

friend

{
    switch (message)
    {
        //====================
 
        case BB_RECONFIGURE:
        {
            pWorkspaces->UpdateWorkspaceNames();
        }
        break;
 
        //====================
 
        case BB_SWITCHTON:
        {
            pWorkspaces->SwitchToWorkspace((int)wParam);
            break;
        }
 
        //====================
 
        case BB_ACTIVETASK:
        {
            // Change workspaces automatically when the active task changes? (e.g. via Alt+Tab)
            if (pSettings->followActive) pWorkspaces->SwitchToWorkspace(pWorkspaces->GetWorkspaceByWindow((HWND)wParam));
        }
 
        //====================
 
        case BB_LISTDESKTOPS:
        {
            DesktopInfo deskInfo;
            ZeroMemory(&deskInfo, sizeof(deskInfo));
            for (int i = 0; i < pSettings->numberOfWorkspaces; i++)
            {
                deskInfo.isCurrent = (pSettings->currentWorkspace == i);
                deskInfo.number = i;
 
                if (pWorkspaces->workspaceNames[i] == "null")
                {
                    sprintf(deskInfo.name, "Workspace %d", i + 1);
                }
                else
                {
                    strcpy(deskInfo.name, pWorkspaces->workspaceNames[i].c_str());
                }
 
                SendMessage((HWND)wParam, BB_DESKTOPINFO, 0, (LPARAM) &deskInfo);
            }
            break;
        }
 
        //====================
 
        case BB_BRINGTOFRONT: 
        {
            // Change window focus via message... (+ change workspace if needed)
            int n = pWorkspaces->GetWorkspaceByWindow((HWND)lParam);
            if (n != pSettings->currentWorkspace) pWorkspaces->SwitchToWorkspace(n);
//          BBSwitchToThisWindow((HWND)lParam, FALSE);
            BringWindowToTop((HWND)lParam);
            break;
        }
 
        //====================
 
        case BB_WORKSPACE:
        {
            switch (wParam)
            {
                case 0: // "BBWS_PreviousWorkspace"
                    pWorkspaces->PreviousWorkspace();
                break;
                case 1: // "BBWS_NextWorkspace"
                    pWorkspaces->NextWorkspace();
                break;
                case 2: // "BBWS_NewWorkspace"
                    pWorkspaces->NewWorkspace();
                break;
                case 3: // "BBWS_RemoveLastWorkspace"
                    pWorkspaces->RemoveLastWorkspace();
                break;
                case 4: // "BBWS_SWITCHTODESK"
                    pWorkspaces->SwitchToWorkspace((int)lParam);
                break;
                case 5: // "BBWS_GATHERWINDOWS"
                    pWorkspaces->GatherWindows();
                break;
                case 6: // "BBWS_MOVEWINDOWLEFT"
                    pWorkspaces->MoveWindowToPreviousWorkspace((HWND)lParam);
                break;
                case 7: // "BBWS_MOVEWINDOWRIGHT"
                    pWorkspaces->MoveWindowToNextWorkspace((HWND)lParam);
                break;
                case 8: // "BBWS_PREVWINDOW"
                    if (pTaskbar) pTaskbar->PreviousTask(!(bool)lParam, false);
                break;
                case 9: // "BBWS_NEXTWINDOW"
                    if (pTaskbar) pTaskbar->NextTask(!(bool)lParam, false);
                break;
                case 10: // "BBWS_LastWorkspace"
                    pWorkspaces->LastWorkspace();
                break;
 
                //====================
 
                // Below: Misc stuff included for for basic compatibility
                // with the bb(C)Lean(Mod)(Zero) modified BBApi...
                case BBWS_TOGGLESTICKY:
                case BBWS_MAKESTICKY:
                case BBWS_CLEARSTICKY:
                case BBWS_TOGGLEONTOP:
                {
                    HWND hwnd = (HWND)lParam;
                    if (hwnd == NULL)
                    {
                        if (pTaskbar) hwnd = pTaskbar->GetActiveWindow();
                        if (hwnd == NULL) hwnd = GetForegroundWindow();
                    }
 
                    if (message == BBWS_TOGGLESTICKY)
                    {
                        if (CheckSticky(hwnd)) RemoveSticky(hwnd);
                        else MakeSticky(hwnd);
                    }
                    else if (message == BBWS_MAKESTICKY) MakeSticky(hwnd);
                    else if (message == BBWS_CLEARSTICKY) RemoveSticky(hwnd);
                    else if (message == BBWS_TOGGLEONTOP)
                    {
                        LONG_PTR windowIsOnTop = GetWindowLongPtr(hwnd, GWL_EXSTYLE);
                        if (windowIsOnTop & WS_EX_TOPMOST) SetWindowPos(hwnd, HWND_NOTOPMOST, 0, 0, 0, 0, SWP_NOMOVE | SWP_NOSIZE | SWP_NOACTIVATE);
                        else SetWindowPos(hwnd, HWND_TOPMOST, 0, 0, 0, 0, SWP_NOMOVE | SWP_NOSIZE | SWP_NOACTIVATE);
                    }
                }
                break;
 
                //====================
 
                default:
                    break; // Note: Breaking as default avoids unintended behaviour if receiving unknown wParam, e.g. ones defined by the bb(C)Lean(Mod)(Zero) modified BBApi...
            }
        }
        break;
 
        //====================
 
        case WM_DISPLAYCHANGE:
        {
            pWorkspaces->ScreenWidth = GetSystemMetrics(SM_CXVIRTUALSCREEN);
            pWorkspaces->ScreenHeight = GetSystemMetrics(SM_CYVIRTUALSCREEN);
        }
 
        //====================
 
        default:
            return DefWindowProc(hwnd,message,wParam,lParam);
    }
    return 0;
}

EnumWindowsProc

BOOL CALLBACK EnumWindowsProc ( HWND hwnd, LPARAM lParam )

friend

{
    // Perform a few window validation checks...
    // (nb. the taskbar already performs many such checks for its tasks prior to adding them, so we leverage that here too)
    if (!IsOnTaskbar(hwnd)) return true;
    if (CheckSticky(hwnd)) return true;
    if (GetWindowLong(hwnd, GWLP_USERDATA) == magicDWord) return true; // For legacy backwards compatibility only (iirc this was used by the earliest bb4win sticky windows implementations)
 
    // Disregard Rainmeter widgets... (i.e. exclude them from the Workspaces handling altogether to avoid possible conflicts)
    char temp[MAX_LINE_LENGTH];
    GetClassName(hwnd, temp, MAX_LINE_LENGTH);
    if (!_stricmp(temp, "RainmeterMeterWindow")) return true;
 
    //====================
 
    RECT r;
    GetWindowRect(hwnd, &r);
 
    int addH = (int)lParam;
    if (addH == -1)
    {
        int screenWidth = pWorkspaces->ScreenWidth;
        int windowWidth = abs(r.right - r.left);
 
        // Initial x/width position calculation...
        if (r.left > screenWidth)
        {
            r.left %= (screenWidth + 10);
            if (r.left > screenWidth) r.left -= (screenWidth + 10);
            r.right = r.left + windowWidth;
        }
        else if (r.left < -10)
        {
            r.left %= (screenWidth + 10);
            while (r.left < -10) r.left += (screenWidth + 10);
            r.right = r.left + windowWidth;
        }
    }
    else
    {
        r.left -= addH;
        r.right -= addH;
    }
 
    HDWP hdwp = DeferWindowPos(pWorkspaces->dwp, hwnd, NULL, r.left, r.top, r.right-r.left, r.bottom-r.top, SWP_NOZORDER|SWP_NOACTIVATE);
    if (hdwp != NULL) pWorkspaces->dwp = hdwp;
/*
    else if (pSettings->debugLogging)
    {
        char title[MAX_LINE_LENGTH], msg[MAX_LINE_LENGTH];
        GetWindowText(hwnd, title, MAX_LINE_LENGTH);
        sprintf(msg, "Workspaces -> DeferWindowPos() failed! -> %s", title);
        SendMessage(GetBBWnd(), BB_CONSOLEMESSAGE, (WPARAM)CONSOLE_ERROR_MESSAGE, (LPARAM)msg);
    }
*/
    return true;
}

Member Data Documentation

hWorkspacesInstance

HINSTANCE Workspaces::hWorkspacesInstance

hWorkspacesWnd

HWND Workspaces::hWorkspacesWnd

workspaceNames

WorkspaceNamesVector Workspaces::workspaceNames

stickyList

StickyListVector Workspaces::stickyList

ScreenWidth

int Workspaces::ScreenWidth

ScreenHeight

int Workspaces::ScreenHeight

dwp

HDWP Workspaces::dwp