CicCaret Class Reference

#include <ciccaret.h>

Collaboration diagram for CicCaret:

Public Types
enum	{ TIMER_ID = 0x4F83AF91 }

Public Member Functions
	CicCaret ()
virtual	~CicCaret ()
	operator HWND () const
void	CreateCaret (HWND hWnd, SIZE size)
void	DestroyCaret ()
void	HideCaret ()
void	InvertCaret ()
void	OnTimer ()
void	SetCaretPos (POINT pt)
void	SetBlinking (BOOL bBlinking)

Protected Attributes
HWND	m_hWnd
UINT	m_uCaretBlinkTimerID
POINT	m_pt
SIZE	m_size
BOOL	m_bCaretBlinking
BOOL	m_bCaretVisible

Detailed Description

Definition at line 10 of file ciccaret.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
TIMER_ID

Definition at line 21 of file ciccaret.h.

{ TIMER_ID = 0x4F83AF91 };

Constructor & Destructor Documentation

CicCaret()

CicCaret::CicCaret

(

)

@implemented

Definition at line 14 of file ciccaret.cpp.

{
    m_bCaretBlinking = FALSE;
    m_bCaretVisible = FALSE;
    m_uCaretBlinkTimerID = 0;
    m_pt.x = m_pt.y = 0;
    m_size.cx = m_size.cy = 0;
}

~CicCaret()

CicCaret::~CicCaret ( )

virtual

@implemented

Definition at line 26 of file ciccaret.cpp.

{
    HideCaret();
    ::KillTimer(m_hWnd, m_uCaretBlinkTimerID);
    m_uCaretBlinkTimerID = 0;
}

Member Function Documentation

CreateCaret()

void CicCaret::CreateCaret	(	HWND	hWnd,
		SIZE	size
	)

@implemented

Definition at line 36 of file ciccaret.cpp.

{
    m_hWnd = hWnd;
    m_size = size;
    if (::IsWindow(hWnd))
        m_uCaretBlinkTimerID = ::SetTimer(m_hWnd, TIMER_ID, ::GetCaretBlinkTime(), NULL);
}

Referenced by UIComposition::CreateCompositionWindow().

DestroyCaret()

void CicCaret::DestroyCaret

(

)

@implemented

Definition at line 47 of file ciccaret.cpp.

{
    HideCaret();
    ::KillTimer(m_hWnd, m_uCaretBlinkTimerID);
    m_uCaretBlinkTimerID = 0;
}

Referenced by UIComposition::DestroyCompositionWindow().

HideCaret()

void CicCaret::HideCaret

(

)

@implemented

Definition at line 57 of file ciccaret.cpp.

{
    if (m_bCaretVisible)
    {
        m_bCaretVisible = FALSE;
        InvertCaret();
    }
    m_bCaretBlinking = FALSE;
}

Referenced by DestroyCaret(), UIComposition::OnImeSetContextAfter(), and ~CicCaret().

InvertCaret()

void CicCaret::InvertCaret

(

)

@implemented

Definition at line 70 of file ciccaret.cpp.

{
    HDC hDC = ::GetDC(m_hWnd);
    ::PatBlt(hDC, m_pt.x, m_pt.y, m_size.cx, m_size.cy, DSTINVERT);
    ::ReleaseDC(m_hWnd, hDC);
}

Referenced by HideCaret(), OnTimer(), and SetCaretPos().

OnTimer()

void CicCaret::OnTimer

(

)

@implemented

Definition at line 80 of file ciccaret.cpp.

{
    if (m_bCaretBlinking)
    {
        m_bCaretVisible = !m_bCaretVisible;
        InvertCaret();
    }
}

Referenced by UIComposition::OnTimer().

operator HWND()

CicCaret::operator HWND ( ) const

inline

Definition at line 24 of file ciccaret.h.

{ return m_hWnd; }

SetBlinking()

void CicCaret::SetBlinking

(

BOOL

bBlinking

)

@implemented

Definition at line 107 of file ciccaret.cpp.

{
    m_bCaretBlinking = bBlinking;
}

SetCaretPos()

void CicCaret::SetCaretPos

(

POINT

pt

)

@implemented

Definition at line 92 of file ciccaret.cpp.

{
    BOOL bCaretVisible = m_bCaretVisible;
    if (bCaretVisible)
        InvertCaret();
 
    m_pt = pt;
 
    if (bCaretVisible)
        InvertCaret();
}

Member Data Documentation

m_bCaretBlinking

BOOL CicCaret::m_bCaretBlinking

protected

Definition at line 17 of file ciccaret.h.

Referenced by CicCaret(), HideCaret(), OnTimer(), and SetBlinking().

m_bCaretVisible

BOOL CicCaret::m_bCaretVisible

protected

Definition at line 18 of file ciccaret.h.

Referenced by CicCaret(), HideCaret(), OnTimer(), and SetCaretPos().

m_hWnd

HWND CicCaret::m_hWnd

protected

Definition at line 13 of file ciccaret.h.

Referenced by CreateCaret(), DestroyCaret(), InvertCaret(), operator HWND(), and ~CicCaret().

m_pt

POINT CicCaret::m_pt

protected

Definition at line 15 of file ciccaret.h.

Referenced by CicCaret(), InvertCaret(), and SetCaretPos().

m_size

SIZE CicCaret::m_size

protected

Definition at line 16 of file ciccaret.h.

Referenced by CicCaret(), CreateCaret(), and InvertCaret().

m_uCaretBlinkTimerID

UINT CicCaret::m_uCaretBlinkTimerID

protected

Definition at line 14 of file ciccaret.h.

Referenced by CicCaret(), CreateCaret(), DestroyCaret(), and ~CicCaret().

---

The documentation for this class was generated from the following files:

• sdk/lib/cicero/ciccaret.h
• sdk/lib/cicero/ciccaret.cpp