duilib中CTextUI控件設置文字時不刷新顯示的bug

duilib中常用的文本控件CTextUI，有個很重要的特性：控件的長度會自適應所設置文本的長度，即所設置文本的的長度變化了，控件的長度也會隨之變化。但是會有這樣的問題：當設置的文本長度大於先前舊的文本的長度時，界面沒有及時刷新，仍然顯示的是之前的舊的文本，需要通過頁面的切換才能刷新顯示。下面我們來詳細看一下自適應特性是如何實現的、是如何被應用的、自適應特性引起的問題以及問題是如何來解決的。

1、自適應特性的實現

CTextUI控件提供了EstimateSize接口，接口的代碼如下所示。

[cpp] view plain copy print ?

SIZE CTextUI::EstimateSize(SIZE szAvailable)
{
RECT rcText = { 0, 0, MAX(szAvailable.cx, m_cxyFixed.cx), 9999 };
rcText.left += m_rcTextPadding.left;
rcText.right -= m_rcTextPadding.right;
if( m_bShowHtml )
{
int nLinks = 0;
CRenderEngine::DrawHtmlText(m_pManager->GetPaintDC(), m_pManager, rcText, m_sText, m_dwTextColor, NULL, NULL, nLinks, DT_CALCRECT | m_uTextStyle);
}
else
{
CRenderEngine::DrawText(m_pManager->GetPaintDC(), m_pManager, rcText, m_sText, m_dwTextColor, m_iFont, DT_CALCRECT | m_uTextStyle);
}
SIZE cXY = {rcText.right - rcText.left + m_rcTextPadding.left + m_rcTextPadding.right,
rcText.bottom - rcText.top + m_rcTextPadding.top + m_rcTextPadding.bottom};
if( m_cxyFixed.cy != 0 ) cXY.cy = m_cxyFixed.cy;
return cXY;
}

SIZE CTextUI::EstimateSize(SIZE szAvailable)
{
    RECT rcText = { 0, 0, MAX(szAvailable.cx, m_cxyFixed.cx), 9999 };
    rcText.left += m_rcTextPadding.left;
    rcText.right -= m_rcTextPadding.right;
    if( m_bShowHtml )
	{   
        int nLinks = 0;
        CRenderEngine::DrawHtmlText(m_pManager->GetPaintDC(), m_pManager, rcText, m_sText, m_dwTextColor, NULL, NULL, nLinks, DT_CALCRECT | m_uTextStyle);
    }
    else
	{
        CRenderEngine::DrawText(m_pManager->GetPaintDC(), m_pManager, rcText, m_sText, m_dwTextColor, m_iFont, DT_CALCRECT | m_uTextStyle);
    }
    SIZE cXY = {rcText.right - rcText.left + m_rcTextPadding.left + m_rcTextPadding.right,
        rcText.bottom - rcText.top + m_rcTextPadding.top + m_rcTextPadding.bottom};

    if( m_cxyFixed.cy != 0 ) cXY.cy = m_cxyFixed.cy;
    return cXY;
}

從上面代碼我們看出，給DrawHtmlText和DrawText函數均傳入了rcText，並且在接下來的代碼中，利用rcText修正了控件相關的位置信息。代碼看起來會有疑問，本接口僅僅是用來估計控件的大小，爲什麼要調用DrawHtmlText和DrawText函數呢？是用這兩個函數來實現估計的？那我們接着看看CRenderEngine::DrawText的代碼。

[cpp] view plain copy print ?

void CRenderEngine::DrawText( HDC hDC, CPaintManagerUI* pManager, RECT& rc, LPCTSTR pstrText, DWORD dwTextColor, int iFont, UINT uStyle )
{
ASSERT(::GetObjectType(hDC) == OBJ_DC || ::GetObjectType(hDC) == OBJ_MEMDC);
if (pstrText == NULL || pManager == NULL) return;
::SetBkMode(hDC, TRANSPARENT);
::SetTextColor(hDC, RGB(GetBValue(dwTextColor), GetGValue(dwTextColor), GetRValue(dwTextColor)));
HFONT hOldFont = (HFONT)::SelectObject(hDC, pManager->GetFont(iFont));
::DrawText(hDC, pstrText, -1, &rc, uStyle | DT_NOPREFIX );
::SelectObject(hDC, hOldFont);
}

void CRenderEngine::DrawText( HDC hDC, CPaintManagerUI* pManager, RECT& rc, LPCTSTR pstrText, DWORD dwTextColor, int iFont, UINT uStyle )
{
    ASSERT(::GetObjectType(hDC) == OBJ_DC || ::GetObjectType(hDC) == OBJ_MEMDC);
    if (pstrText == NULL || pManager == NULL) return;
    ::SetBkMode(hDC, TRANSPARENT);
    ::SetTextColor(hDC, RGB(GetBValue(dwTextColor), GetGValue(dwTextColor), GetRValue(dwTextColor)));
    HFONT hOldFont = (HFONT)::SelectObject(hDC, pManager->GetFont(iFont));
    ::DrawText(hDC, pstrText, -1, &rc, uStyle | DT_NOPREFIX );
    ::SelectObject(hDC, hOldFont);
}

代碼是將文字繪製到制定的dc上，那到底是如何實現估計的呢？只能一步步看，於是到msdn中查看::DrawText API的函數說明，如下所示。

[cpp] view plain copy print ?

int DrawText(
HDC hDC, // handle to DC
LPCTSTR lpString, // text to draw
int nCount, // text length
LPRECT lpRect, // formatting dimensions
UINT uFormat // text-drawing options
);

int DrawText(
  HDC hDC,          // handle to DC
  LPCTSTR lpString, // text to draw
  int nCount,       // text length
  LPRECT lpRect,    // formatting dimensions
  UINT uFormat      // text-drawing options
);

注意第四個參數，對應的說明：

lpRect: [in/out] Pointer to a RECT structure that contains the rectangle (in logical coordinates) in which the text is to be formatted.

它既是一個傳入參數，也是一個傳出參數，傳出應該就是所繪畫文字繪畫後所佔用的實際區域大小。所以結合上面的追蹤過程，正是給DrawHtmlText和DrawText函數均傳入了rcText參數，並且執行完後將繪畫的文字佔用的實際大小返回給了rcText傳了出來，進而用實際佔用大小來重新更新CTextUI控件的大小，這樣就實現了控件對文字長度的自適應特性。

2、自適應特性的使用

這種自適應的特性可以巧妙的用在一些場合下面。比如類似於QQ討論組的聊天框，在聊天框的右側會顯示當前的討論組成員列表，如果成員是管理員，我們需要在成員名稱後面添加一個小圖標，以標識該成員是管理員。一般的做法是，利用CContainer的自動佈局特性，我們將不變寬度的控件設置固定寬度值，位於右邊的管理員圖標寬度也設置爲固定值，這樣中間的成員名稱是文本，可長可短，不設置成固定值，使用CLabelUI控件即可。這樣，中間的名稱寬度就是可變的，但是這樣做有個問題，管理員圖標會固定在每個成員item的左右邊，不能跟隨名稱緊貼名稱後面，顯得不太美觀。後來考慮到CTextUI的對文字長度能自適應，就改用CTextUI，能很好的實現管理員圖標能緊貼在成員名稱後面。

3、自適應特性引起的問題及問題分析

上面列舉的例子中，當成員名稱過長時，由於討論組成員列表的寬度是固定的，當名稱過長時，會將管理員圖標給擠掉，看不見了或顯示不全。這該如何解決呢？好在CTextUI有個maxwidth屬性來設置最大寬度，這樣我們將管理員圖標位置預留出來，估計出控件的最大寬度，設置一下即可，當成員名稱顯示不下時，以省略號顯示。

除了這個問題，還有個更嚴重的問題：當設置的文本長度大於先前舊的文本的長度時，界面沒有及時刷新，仍然顯示的是之前的舊的文本，需要通過頁面的切換才能刷新顯示。CTextUI是duilib中的基本控件，有這個問題是沒法使用的，是要想辦法解決掉的。

原因估計是這樣的：由於CTextUI是自適應文字寬度的，對於舊的能顯示全的文字，寬度是和文字寬度一致的；當我們設置更長的文字時，估計沒有沒有觸發CTextUI::EstimateSize接口的調用，導致控件還是以前的大小，從而出現新文字沒有刷新或顯示不全的問題。

下面我們就來從代碼中看一下不能刷新顯示的問題是如何產生的。設置文字時，會調用基類CControlUI的SetText接口，接口的代碼如下所示。

[cpp] view plain copy print ?

void CControlUI::SetText( LPCTSTR pstrText )
{
if( m_sText == pstrText )
{
return;
}
m_sText = pstrText;
Invalidate();
}

void CControlUI::SetText( LPCTSTR pstrText )
{
    if( m_sText == pstrText ) 
	{
		return;
	}

    m_sText = pstrText;
    Invalidate();
}

在上面的代碼中調用CControlUI::Invalidate函數，

[cpp] view plain copy print ?

void CControlUI::Invalidate()
{
if( !IsVisible() ) return;
RECT invalidateRc = m_rcItem;
CControlUI* pParent = this;
RECT rcTemp;
RECT rcParent;
while( pParent = pParent->GetParent() )
{
rcTemp = invalidateRc;
rcParent = pParent->GetPos();
if( !::IntersectRect(&invalidateRc, &rcTemp, &rcParent) )
{
return;
}
}
if( m_pManager != NULL ) m_pManager->Invalidate(invalidateRc);
}

void CControlUI::Invalidate()
{
	if( !IsVisible() ) return;

	RECT invalidateRc = m_rcItem;

	CControlUI* pParent = this;
	RECT rcTemp;
	RECT rcParent;
	while( pParent = pParent->GetParent() )
	{
		rcTemp = invalidateRc;
		rcParent = pParent->GetPos();
		if( !::IntersectRect(&invalidateRc, &rcTemp, &rcParent) ) 
		{
			return;
		}
	}

	if( m_pManager != NULL ) m_pManager->Invalidate(invalidateRc);
}

然後調到CPaintManagerUI::Invalidate中，即

[cpp] view plain copy print ?

void CPaintManagerUI::Invalidate(RECT& rcItem)
{
::InvalidateRect(m_hWndPaint, &rcItem, FALSE);
}

void CPaintManagerUI::Invalidate(RECT& rcItem)
{
    ::InvalidateRect(m_hWndPaint, &rcItem, FALSE);
}

也就是最終調用API函數::InvalidateRect，產生一個WM_PAINT消息。於是進入CPaintManagerUI::MessageHandler中，查看收到WM_PAINT消息是如何處理的。

[cpp] view plain copy print ?

bool CPaintManagerUI::MessageHandler(UINT uMsg, WPARAM wParam, LPARAM lParam, LRESULT& lRes)
{
......
case WM_PAINT:
{
// Should we paint?
RECT rcPaint = { 0 };
if( !::GetUpdateRect( m_hWndPaint, &rcPaint, FALSE) )
{
return true;
}
if( NULL == m_pRoot )
{
PAINTSTRUCT ps = { 0 };
::BeginPaint( m_hWndPaint, &ps );
::EndPaint( m_hWndPaint, &ps );
return true;
}
// Do we need to resize anything?
// This is the time where we layout the controls on the form.
// We delay this even from the WM_SIZE messages since resizing can be
// a very expensive operation.
if( m_bUpdateNeeded )
{
m_bUpdateNeeded = false;
RECT rcClient = { 0 };
::GetClientRect( m_hWndPaint, &rcClient );
if( !::IsRectEmpty( &rcClient ) )
{
if( m_pRoot->IsUpdateNeeded() )
{
m_pRoot->SetPos( rcClient );
if( m_hDcOffscreen != NULL ) ::DeleteDC( m_hDcOffscreen );
if( m_hDcBackground != NULL ) ::DeleteDC( m_hDcBackground );
if( m_hbmpOffscreen != NULL ) ::DeleteObject( m_hbmpOffscreen );
if( m_hbmpBackground != NULL ) ::DeleteObject( m_hbmpBackground );
m_hDcOffscreen = NULL;
m_hDcBackground = NULL;
m_hbmpOffscreen = NULL;
m_hbmpBackground = NULL;
}
else
{
CControlUI* pControl = NULL;
while( pControl = m_pRoot->FindControl(__FindControlFromUpdate, NULL, UIFIND_VISIBLE | UIFIND_ME_FIRST) )
{
pControl->SetPos( pControl->GetPos() );
}
}
......
}

bool CPaintManagerUI::MessageHandler(UINT uMsg, WPARAM wParam, LPARAM lParam, LRESULT& lRes)
{
......
    case WM_PAINT:
        {
            // Should we paint?
            RECT rcPaint = { 0 };
            if( !::GetUpdateRect( m_hWndPaint, &rcPaint, FALSE) ) 
			{
				return true;
			}

            if( NULL == m_pRoot ) 
			{
                PAINTSTRUCT ps = { 0 };
                ::BeginPaint( m_hWndPaint, &ps );
                ::EndPaint( m_hWndPaint, &ps );
                return true;
            }            
            // Do we need to resize anything?
            // This is the time where we layout the controls on the form.
            // We delay this even from the WM_SIZE messages since resizing can be
            // a very expensive operation.
            if( m_bUpdateNeeded ) 
			{
                m_bUpdateNeeded = false;
                RECT rcClient = { 0 };
                ::GetClientRect( m_hWndPaint, &rcClient );
                if( !::IsRectEmpty( &rcClient ) ) 
				{
                    if( m_pRoot->IsUpdateNeeded() ) 
					{
                        m_pRoot->SetPos( rcClient );
                        if( m_hDcOffscreen != NULL ) ::DeleteDC( m_hDcOffscreen );
                        if( m_hDcBackground != NULL ) ::DeleteDC( m_hDcBackground );
                        if( m_hbmpOffscreen != NULL ) ::DeleteObject( m_hbmpOffscreen );
                        if( m_hbmpBackground != NULL ) ::DeleteObject( m_hbmpBackground );
                        m_hDcOffscreen = NULL;
                        m_hDcBackground = NULL;
                        m_hbmpOffscreen = NULL;
                        m_hbmpBackground = NULL;
                    }
					else 
					{
						CControlUI* pControl = NULL;
						while( pControl = m_pRoot->FindControl(__FindControlFromUpdate, NULL, UIFIND_VISIBLE | UIFIND_ME_FIRST) ) 
						{
							pControl->SetPos( pControl->GetPos() );
						}
					}
......
}

上面只給出了一部分代碼。搜索一下調用EstimateSize函數的地方，發現CVerticalLayoutUI、CHorizontalLayoutUI、CTileLayoutUI和CTabLayoutUI類的SetPos函數中都會調到EstimateSize函數。從上面的代碼可以看出，僅僅是產生一個WM_PAINT消息是不行的，是執行不到CVerticalLayoutUI、CHorizontalLayoutUI、CTileLayoutU等類的SetPos函數，執行不到CTextUI::EstimateSize函數的。也就是說，在設置文字的CControlUI::SetText函數中僅僅調用CControlUI::Invalidate函數是行不通的，是沒法更新CTextUI控件大小的。
要調用到CVerticalLayoutUI、CHorizontalLayoutUI、CTileLayoutU等類的SetPos函數，首先要CPaintManagerUI::m_bUpdateNeeded爲TRUE，那是不是要調用CPaintManagerUI::NeedUpdate()，先將m_bUpdateNeeded置爲TRUE呢？於是加上代碼，CTextUI文字還是刷新不了。於是繼續看上面的代碼，發現只有當CControlUI::m_bUpdateNeeded爲TRUE時，纔會調用控件對應的SetPos接口。於是有添加了CControlUI::NeedUpdate調用，問題還是沒解決。其實，此時只是觸發了控件本身CTextUI::SetPos的調用，此函數並沒有調用CTextUI::EstimateSize，當然CTextUI::SetPos中不可能直接調用CTextUI::EstimateSize，是由於牽涉到父佈局中的所有子控件（包括CTextUI控件）的擺放，理應由父佈局統一統籌。

4、自適應特性引起的不刷新問題的解決

那如何才能調到CTextUI::EstimateSize呢？該如何處理呢？考慮到CVerticalLayoutUI、CHorizontalLayoutUI、CTileLayoutUI和CTabLayoutUI類的SetPos函數中都會調到EstimateSize函數，而CTextUI控件一般是依附在CVerticalLayoutUI、CHorizontalLayoutUI等父佈局下的，那麼只要我們觸發這些父佈局調用對應的SetPos，就可以調用到CTextUI::EstimateSize函數，進而利用最新的文字來估計CTextUI控件的尺寸，將CTextUI控件的尺寸更新掉，從而能讓最新的文字刷新顯示出來。

那如何觸發這些父佈局調用對應的SetPos呢？我們且看CPaintManagerUI::MessageHandler中代碼，

[cpp] view plain copy print ?

bool CPaintManagerUI::MessageHandler(UINT uMsg, WPARAM wParam, LPARAM lParam, LRESULT& lRes)
{
......
case WM_PAINT:
{
......
if( m_bUpdateNeeded )
{
m_bUpdateNeeded = false;
RECT rcClient = { 0 };
::GetClientRect( m_hWndPaint, &rcClient );
if( !::IsRectEmpty( &rcClient ) )
{
if( m_pRoot->IsUpdateNeeded() )
{
m_pRoot->SetPos( rcClient );
if( m_hDcOffscreen != NULL ) ::DeleteDC( m_hDcOffscreen );
if( m_hDcBackground != NULL ) ::DeleteDC( m_hDcBackground );
if( m_hbmpOffscreen != NULL ) ::DeleteObject( m_hbmpOffscreen );
if( m_hbmpBackground != NULL ) ::DeleteObject( m_hbmpBackground );
m_hDcOffscreen = NULL;
m_hDcBackground = NULL;
m_hbmpOffscreen = NULL;
m_hbmpBackground = NULL;
}
else
{
CControlUI* pControl = NULL;
while( pControl = m_pRoot->FindControl(__FindControlFromUpdate, NULL, UIFIND_VISIBLE | UIFIND_ME_FIRST) )
{
pControl->SetPos( pControl->GetPos() );
}
}
......
}

bool CPaintManagerUI::MessageHandler(UINT uMsg, WPARAM wParam, LPARAM lParam, LRESULT& lRes)
{
......
    case WM_PAINT:
        {
 ......
            if( m_bUpdateNeeded ) 
			{
                m_bUpdateNeeded = false;
                RECT rcClient = { 0 };
                ::GetClientRect( m_hWndPaint, &rcClient );
                if( !::IsRectEmpty( &rcClient ) ) 
				{
                    if( m_pRoot->IsUpdateNeeded() ) 
					{
                        m_pRoot->SetPos( rcClient );
                        if( m_hDcOffscreen != NULL ) ::DeleteDC( m_hDcOffscreen );
                        if( m_hDcBackground != NULL ) ::DeleteDC( m_hDcBackground );
                        if( m_hbmpOffscreen != NULL ) ::DeleteObject( m_hbmpOffscreen );
                        if( m_hbmpBackground != NULL ) ::DeleteObject( m_hbmpBackground );
                        m_hDcOffscreen = NULL;
                        m_hDcBackground = NULL;
                        m_hbmpOffscreen = NULL;
                        m_hbmpBackground = NULL;
                    }
 					else 
					{
 						CControlUI* pControl = NULL;
						while( pControl = m_pRoot->FindControl(__FindControlFromUpdate, NULL, UIFIND_VISIBLE | UIFIND_ME_FIRST) ) 
						{
							pControl->SetPos( pControl->GetPos() );
						}
					}
......
}

如果讓整個窗口的m_pRoot全佈局全部刷新一遍，肯定實現上述更新CTextUI控件尺寸的目的。但是這代價太高了，僅僅是爲了刷新一個CTextUI子控件的位置和尺寸，就讓窗口的整個佈局都重新刷新一遍，這肯定不可取的、不合理的。於是看其中的這段代碼，

[cpp] view plain copy print ?

else
CControlUI* pControl = NULL;
while( pControl = m_pRoot->FindControl(__FindControlFromUpdate, NULL, UIFIND_VISIBLE | UIFIND_ME_FIRST) )
{
pControl->SetPos( pControl->GetPos() );
}

 					else 
					{
 						CControlUI* pControl = NULL;
						while( pControl = m_pRoot->FindControl(__FindControlFromUpdate, NULL, UIFIND_VISIBLE | UIFIND_ME_FIRST) ) 
						{
							pControl->SetPos( pControl->GetPos() );
						}
					}

繼續跟到__FindControlFromUpdate函數，如下所示。

[cpp] view plain copy print ?

CControlUI* CALLBACK CPaintManagerUI::__FindControlFromUpdate( CControlUI* pThis, LPVOID pData )
{
return pThis->IsUpdateNeeded() ? pThis : NULL;
}

CControlUI* CALLBACK CPaintManagerUI::__FindControlFromUpdate( CControlUI* pThis, LPVOID pData )
{
    return pThis->IsUpdateNeeded() ? pThis : NULL;
}

所以，我們只要將CTextUI所依附的父佈局CVerticalLayoutUI或者CHorizontalLayoutUI等設置爲需要刷新即可調用到CVerticalLayoutUI或者CHorizontalLayoutUI等的SetPos函數。所以最終的解決辦法：在CTextUI中重寫父類CControlUI中的虛函數SetText，添加的代碼如下所示。

[cpp] view plain copy print ?

void CTextUI::SetText( LPCTSTR pstrText )
{
CControlUI::SetText( pstrText );
NeedParentUpdate();
}

void CTextUI::SetText( LPCTSTR pstrText )
{
	CControlUI::SetText( pstrText );

	NeedParentUpdate();
}

爲了說明問題，將CControlUI::NeedParentUpdate的代碼也貼出來，

[cpp] view plain copy print ?

void CControlUI::NeedParentUpdate()
{
if( GetParent() )
{
GetParent()->NeedUpdate();
GetParent()->Invalidate();
}
else
{
NeedUpdate();
}
if( m_pManager != NULL )
{
m_pManager->NeedUpdate();
}
}

void CControlUI::NeedParentUpdate()
{
    if( GetParent() )
    {
        GetParent()->NeedUpdate();
        GetParent()->Invalidate();
    }
    else
    {
        NeedUpdate();
    }

    if( m_pManager != NULL )
    {
        m_pManager->NeedUpdate();
    }
}

所以CTextUI::SetText不僅將父佈局設置爲需要刷新狀態，而且調用CPaintManagerUI::NeedUpdate將m_bUpdateNeeded置爲TRUE，進而保證代碼能運行到CPaintManagerUI::MessageHandler中的WM_PAINT消息處理分支的如下代碼段，

[cpp] view plain copy print ?

else
CControlUI* pControl = NULL;
while( pControl = m_pRoot->FindControl(__FindControlFromUpdate, NULL, UIFIND_VISIBLE | UIFIND_ME_FIRST) )
{
pControl->SetPos( pControl->GetPos() );
}

 					else 
					{
 						CControlUI* pControl = NULL;
						while( pControl = m_pRoot->FindControl(__FindControlFromUpdate, NULL, UIFIND_VISIBLE | UIFIND_ME_FIRST) ) 
						{
							pControl->SetPos( pControl->GetPos() );
						}
					}

最終解決本案例中CTextUI控件不刷新顯示的問題。

http://blog.csdn.net/chenlycly/article/details/17291765#

duilib中CTextUI控件設置文字時不刷新顯示的bug

再談23種設計模式（3）：行爲型模式（學習筆記）

Power Automate Desktop 安裝完，登錄後老是提示one driver 錯誤

微前端學習筆記(4):從微前端到微模塊之EMP與hel-micro方案探索

微前端學習筆記（1）：微前端總體架構概述，從微服務發微

985 碩士程序員，空窗 4 個月沒有 Offer！

一文搞懂 Spring 循環依賴

賽博鬥地主——使用大語言模型扮演Agent智能體玩牌類遊戲。

VScode右鍵打開(添加到右鍵)

記一次 .NET某工控視覺自動化系統卡死分析

WindowsServer--SQL Server搭建主從同步實現讀寫分離 - 事務性分發

duilib中CTextUI控件設置文字時不刷新顯示的bug

桶形失真

Mysql到Redis的數據協議

用apt-get install安裝的文件被放到哪裏

[算法導論]快速排序

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結