dialog_helper::dialog_modeless

#include <win32_dialog.h>

Public Member Functions
	__declspec (deprecated) bool create(unsigned p_id

Data Fields
HWND HINSTANCE	p_instance = core_api::get_my_instance())
HWND	p_parent

Protected Member Functions
	dialog_modeless ()
virtual	~dialog_modeless ()
HWND	get_wnd () const
virtual BOOL	on_message (UINT msg, WPARAM wp, LPARAM lp)=0

Private Types
enum	{ destructor_none, destructor_normal, destructor_fromwindow }

Private Member Functions
BOOL	on_message_wrap (UINT msg, WPARAM wp, LPARAM lp)
void	on_window_destruction ()

Static Private Member Functions
static INT_PTR CALLBACK	DlgProc (HWND wnd, UINT msg, WPARAM wp, LPARAM lp)

Private Attributes
enum dialog_helper::dialog_modeless:: { ... }	m_destructor_status
bool	m_is_in_create
HWND	m_wnd

Detailed Description

This class is meant to be used with new/delete operators only. Destroying the window - outside create() / WM_INITDIALOG - will result in object calling delete this. If object is deleted directly using delete operator, WM_DESTROY handler may not be called so it should not be used (use destructor of derived class instead). Classes derived from dialog_modeless must not be instantiated in any other way than operator new().

Typical usage :
class mydialog : public dialog_helper::dialog_modeless {...}; (...) bool createmydialog() { mydialog * instance = new mydialog; if (instance == 0) return flase; if (!instance->create(...)) {delete instance; return false;} return true; }

Definition at line 69 of file win32_dialog.h.

Member Enumeration Documentation

anonymous enum

private

Enumerator
destructor_none
destructor_normal
destructor_fromwindow

Definition at line 89 of file win32_dialog.h.

{destructor_none,destructor_normal,destructor_fromwindow} m_destructor_status;

Constructor & Destructor Documentation

dialog_helper::dialog_modeless::dialog_modeless ( )

inlineprotected

Definition at line 79 of file win32_dialog.h.

: m_wnd(0), m_destructor_status(destructor_none), m_is_in_create(false) {}

dialog_helper::dialog_modeless::~dialog_modeless ( )

protectedvirtual

Definition at line 111 of file win32_dialog.cpp.

                                      {
        assert(!m_is_in_create);
        switch(m_destructor_status)
        {
        case destructor_none:
            m_destructor_status = destructor_normal;
            if (m_wnd != 0)
            {
                DestroyWindow(m_wnd);
                m_wnd = 0;
            }
            break;
        case destructor_fromwindow:
            if (m_wnd != 0) SetWindowLongPtr(m_wnd,DWLP_USER,0);
            break;
        default:
            //should never trigger
            pfc::crash();
            break;
        }
    }

Member Function Documentation

dialog_helper::dialog_modeless::__declspec

(

deprecated

)

Creates the dialog window. This will call on_message with WM_INITDIALOG. To abort creation, you can call DestroyWindow() on our window; it will not delete the object but make create() return false instead. You should not delete the object from inside WM_INITDIALOG handler or anything else possibly called from create().

Returns

true on success, false on failure.

INT_PTR CALLBACK dialog_helper::dialog_modeless::DlgProc ( HWND  wnd, UINT  msg, WPARAM  wp, LPARAM  lp  )

staticprivate

Definition at line 162 of file win32_dialog.cpp.

    {
        dialog_modeless * thisptr;
        BOOL rv;
        if (msg == WM_INITDIALOG)
        {
            thisptr = reinterpret_cast<dialog_modeless*>(lp);
            thisptr->m_wnd = wnd;
            SetWindowLongPtr(wnd,DWLP_USER,lp);
            modeless_dialog_manager::g_add(wnd);
        }
        else thisptr = reinterpret_cast<dialog_modeless*>(GetWindowLongPtr(wnd,DWLP_USER));

        rv = thisptr ? thisptr->on_message_wrap(msg,wp,lp) : FALSE;

        if (msg == WM_DESTROY)
            modeless_dialog_manager::g_remove(wnd);

        if (msg == WM_DESTROY && thisptr != 0)
            thisptr->on_window_destruction();

        return rv;
    }

HWND dialog_helper::dialog_modeless::get_wnd ( ) const

inlineprotected

Definition at line 80 of file win32_dialog.h.

{return m_wnd;}

virtual BOOL dialog_helper::dialog_modeless::on_message ( UINT  msg, WPARAM  wp, LPARAM  lp  )

protectedpure virtual

Standard windows message handler (DialogProc-style). Use get_wnd() to retrieve our dialog window handle.

BOOL dialog_helper::dialog_modeless::on_message_wrap ( UINT  msg, WPARAM  wp, LPARAM  lp  )

private

Definition at line 154 of file win32_dialog.cpp.

    {
        if (m_destructor_status == destructor_none)
            return on_message(msg,wp,lp);
        else
            return FALSE;
    }

void dialog_helper::dialog_modeless::on_window_destruction ( )

private

Definition at line 133 of file win32_dialog.cpp.

    {
        if (m_is_in_create)
        {
            m_wnd = 0;
        }
        else
        switch(m_destructor_status)
        {
        case destructor_none:
            m_destructor_status = destructor_fromwindow;
            delete this;
            break;
        case destructor_fromwindow:
            pfc::crash();
            break;
        default:
            break;
        }
    }

Field Documentation

enum { ... } dialog_helper::dialog_modeless::m_destructor_status

bool dialog_helper::dialog_modeless::m_is_in_create

private

Definition at line 90 of file win32_dialog.h.

HWND dialog_helper::dialog_modeless::m_wnd

private

Definition at line 88 of file win32_dialog.h.

HWND HINSTANCE dialog_helper::dialog_modeless::p_instance = core_api::get_my_instance())

Definition at line 74 of file win32_dialog.h.

HWND dialog_helper::dialog_modeless::p_parent

Definition at line 74 of file win32_dialog.h.

---

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

• foobar2000/helpers/win32_dialog.h
• foobar2000/helpers/win32_dialog.cpp