CRTextUpdateEvent.cpp

Go to the documentation of this file.

// Name:        wxGuiTest/CapturedEvents/CRTextUpdateEvent.cpp
// Author:      Reinhold Fuereder
// Created:     2004
// Copyright:   (c) 2005 Reinhold Fuereder
// Modifications: John Ralls, 2007-2008
// Modifications Copyright: (c) 2008 John Ralls
// Licence:     wxWindows licence
//
// $Id$

#ifdef __GNUG__
    #pragma implementation "CRTextUpdateEvent.h"
#endif

#include "CRTextUpdateEvent.h"

#include <wx/spinctrl.h>

#include <wxGuiTest/CRWindowHierarchyHandler.h>
#include <wxGuiTest/CRCppEmitter.h>
#include <wxGuiTest/EventSimulationHelper.h>


using namespace wxTst;


CRTextUpdateEvent::CRTextUpdateEvent (wxEvent *event) :
    CRCapturedEvent (event),  m_isIrrelevant(false)
{
//    Nothing to do
}


CRTextUpdateEvent::~CRTextUpdateEvent ()
{
    // Nothing to do
}


bool CRTextUpdateEvent::IsPending () const
{
    return true;
}


bool CRTextUpdateEvent::IsIrrelevant () const
{
    return m_isIrrelevant;
}


void CRTextUpdateEvent::Process (CRCapturedEvent **pendingEvt)
{
    wxWindow *wdwEvtObject = wxDynamicCast (m_event->GetEventObject (), wxWindow);
    wxASSERT (wdwEvtObject != NULL);

    // Text updates of double typed spin controls are irrelevant:
    if (wdwEvtObject->GetParent () != NULL
    && wdwEvtObject->IsKindOf (CLASSINFO(wxSpinCtrl))) {
        
    if (!EventSimulationHelper::IsSettingSpinCtrlValue ()) {

        m_isIrrelevant = true;
        // Standard wxSpinCtrl do NOT trigger a spin control event when
        // text, i.e. the integer value, is entered -> simulate spin
        // control update event:
        wxSpinCtrl *spinCtrl = wxDynamicCast (wdwEvtObject, wxSpinCtrl);
        wxASSERT (spinCtrl != NULL);
        EventSimulationHelper::SetSpinCtrlValue(spinCtrl,
                             spinCtrl->GetValue());
    }
    return;
    }


    // If pending event is another text update event on the same (!) control,
    // then destroy it to prevent undesirable code emitting:
    if (*pendingEvt != NULL) {

        CRTextUpdateEvent *pendingTextUpdateEvt =
                dynamic_cast< CRTextUpdateEvent * >(*pendingEvt);
        if (pendingTextUpdateEvt != NULL) {

            if (m_event->GetEventObject () ==
                    pendingTextUpdateEvt->GetEvent ()->GetEventObject ()) {

                delete *pendingEvt;
                *pendingEvt = NULL;
            }
        }
    }

    CRWindowHierarchyHandler *hierarchy = CRWindowHierarchyHandler::GetInstance ();
    wxASSERT (hierarchy != NULL);

    m_textCtrlName = wdwEvtObject->GetName ();
    m_containerName = hierarchy->FindContainerName (wdwEvtObject);
    wxASSERT (!m_containerName.IsEmpty ());

    wxASSERT (m_event->IsCommandEvent ());
    wxCommandEvent *cmdEvt = wxDynamicCast (m_event, wxCommandEvent);
    wxASSERT (cmdEvt != NULL);
    m_textCtrlValue = cmdEvt->GetString ();
}


void CRTextUpdateEvent::EmitCpp ()
{
    // Expected emitting (XRC):
    /*
    wxWindow *evtSimHlpTestPanel = wxWindow::FindWindowByName
            ("EvtSimHlpTestPanel");
    CPPUNIT_ASSERT_MESSAGE ("Container window for text control 'TextCtrl' not \
            found", evtSimHlpTestPanel != NULL);
    wxWindow *textCtrlWdw = evtSimHlpTestPanel->FindWindow (XRCID("TextCtrl"));
    CPPUNIT_ASSERT_MESSAGE ("Window for text control 'TextCtrl' not found",
            textCtrlWdw != NULL);
    wxTextCtrl *textCtrl = wxDynamicCast (textCtrlWdw, wxTextCtrl);
    CPPUNIT_ASSERT_MESSAGE ("Converting window for text control 'TextCtrl' \
            failed", textCtrl != NULL);
    wxTst::EventSimulationHelper::SetTextCtrlValue (textCtrl,
            "abc");
    wxTst::WxGuiTestHelper::FlushEventQueue ();
    */
    // Or non-XRC:
    /*
    ...
    wxWindow *textCtrlWdw = evtSimHlpTestPanel->FindWindow ("TextControl");
    ...
    */

    CRCppEmitter *emitter = CRCppEmitter::GetInstance ();

    wxString containerVarName = emitter->AddContainerLookupCode (
            m_containerName, wxString::Format (_T("text control '%s'"),
            m_textCtrlName.c_str ()));

    wxString textCtrlWdwVarName = emitter->MakeVarName (m_textCtrlName,
            _T("Wdw"));

    wxString str;
    str << _T("wxWindow *") << textCtrlWdwVarName << _T(" = ") << 
            containerVarName << _T("->FindWindow (");
    str << _T("_T(\"") << m_textCtrlName << _T("\"));");
    emitter->AddCode (str);

    str.Clear ();
    str << _T("CPPUNIT_ASSERT_MESSAGE (\"Window for text control '") <<
            m_textCtrlName <<  _T("' not found\", ") << textCtrlWdwVarName <<
            _T(" != NULL);");
    emitter->AddCode (str);

    wxString textCtrlVarName = emitter->MakeVarName (m_textCtrlName);

    str.Clear ();
    str << _T("wxTextCtrl *") << textCtrlVarName << _T(" = wxDynamicCast (")
    << textCtrlWdwVarName << _T(", wxTextCtrl);");
    emitter->AddCode (str);

    str.Clear ();
    str <<  _T("CPPUNIT_ASSERT_MESSAGE (\"Converting window for text control '")
    << m_textCtrlName <<  _T("' failed\", ") << textCtrlVarName 
    << _T(" != NULL);");
    emitter->AddCode (str);

    str.Clear ();
    str << _T("wxTst::EventSimulationHelper::SetTextCtrlValue (") 
    << textCtrlVarName << _T(", _T(\"") << this->GetEscaped (m_textCtrlValue)
    << _T("\"));");
    emitter->AddCode (str);

    str.Clear ();
    str << _T("wxTst::WxGuiTestHelper::FlushEventQueue ();\n");
    emitter->AddCode (str);
}


wxString CRTextUpdateEvent::GetEscaped (const wxString &str) const
{
    wxString escaped;

    for (size_t i = 0; i < str.Length (); i++) {

        if (str[i] == 92) { // '\'

            escaped.Append (_T("\\\\"));

        } else {

            escaped.Append (str[i]);
        }
    }

    return escaped;
}

---