WxGuiTestHelper.h

Go to the documentation of this file.

// Name:        wxGuiTest/WxGuiTestHelper.h
// Author:      Reinhold Fuereder
// Created:     2004
// Copyright:   (c) 2005 Reinhold Fuereder
// Modifications: John Ralls, 2009
// Modifications Copyright: (c) 2009 John Ralls
// Licence:     wxWindows licence
//
// $Id$
#ifndef WXGUITESTHELPER_H
#define WXGUITESTHELPER_H

#ifdef __GNUG__
    #pragma interface "WxGuiTestHelper.h"
#endif

#include <wxGuiTest/Common.h>

#include <map>


#ifdef USE_WXGUITESTING
    #ifdef IMPLEMENT_APP
        #undef IMPLEMENT_APP
    #endif
    #define IMPLEMENT_APP(appname)
#endif


namespace wxTst {

class WarningAsserterInterface;


class WxGuiTestHelper
{
public:
    WxGuiTestHelper ();


    virtual ~WxGuiTestHelper ();


    static int FlushEventQueue ();


    static int Show (wxWindow *wdw, bool show, bool isModal);


    static int Show (wxWindow *wdw, bool show, bool isModal,
            bool isGuiLessUnitTest);


    static bool PopupMenu (wxWindow *wdw, wxMenu *menu, const wxPoint &pos,
            const wxString &cacheMapKey);


    static bool PopupMenu (wxWindow *wdw, wxMenu *menu, const wxPoint &pos,
            const wxString &cacheMapKey, bool isGuiLessUnitTest);


    static void BreakTestToShowCurrentGui ();

    static void SetIsGuiLessUnitTestFlag (bool isGuiLess);

    
    static bool IsGuiLessUnitTestFlag ();


    static void SetShowModalDialogsNonModalFlag (bool showNonModal);

    
    static bool GetShowModalDialogsNonModalFlag ();


    static void SetShowPopupMenusFlag (bool showPopupMenus);

    
    static bool GetShowPopupMenusFlag ();

    static void SetInteractive(bool interactive);

    static bool GetInteractive();
    
    static void SetDisableTestInteractivity (bool disable);


    static bool GetDisableTestInteractivity ();


    static void SetPopupWarningForFailingAssert (bool popup);


    static bool GetPopupWarningForFailingAssert ();


    static wxMenu *FindPopupMenu (const wxString &key);


    static wxString FindPopupMenuKey (wxMenu *menu);


    static wxWindow *FindPopupMenuEvtHandlerWdw (const wxString &key);


    static bool IsProvokedWarning (const wxString &caption, const wxString &message);


    static void SetCheckForProvokedWarnings (bool check);


    static bool GetCheckForProvokedWarnings ();


    static void SetWarningAsserter (WarningAsserterInterface *warningAsserter);


    static void AddTestFailure (const wxString &file, const int line,
            const wxString &shortDescription, const wxString &message);

private:
    static bool s_isGuiLessUnitTest;

    static bool s_showModalDialogsNonModal;
    static bool s_showPopupMenus;

    static bool s_interactive;
    static bool s_disableTestInteractivity;

    static bool s_popupWarningForFailingAssert;

    typedef std::pair< wxMenu *, wxWindow * > MenuWdwPair;
    typedef std::map< wxString, MenuWdwPair > PopupMenuMap;
    static PopupMenuMap s_popupMenuMap;

    static bool s_checkForProvokedWarnings;

    static WarningAsserterInterface *s_warningAsserter;

    // For storing test case failures due to failing assertions and unexpected
    // warnings:
    static wxString s_fileOfFirstTestFailure;
    static int s_lineNmbOfFirstTestFailure;
    static wxString s_shortDescriptionOfFirstTestFailure;
    static wxString s_accTestFailures;
};

} // End namespace wxTst

#endif // WXGUITESTHELPER_H

---