xap_Win32DialogHelper.h

Go to the documentation of this file.

// xap_Win32DialogHelper.h

/* AbiWord
 * Copyright (C) 1998 AbiSource, Inc.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 */

#ifndef XAP_Win32DialogHelper_H
#define XAP_Win32DialogHelper_H

// MSVC++ warns about using 'this' in initializer list.
// and the DialogHelper uses 'this' typically for its contructor
#ifdef _MSC_VER
#pragma warning(disable: 4355)
#endif

#include <commctrl.h>

/*****************************************************************/
#include "xap_Frame.h"
#include "xap_Win32FrameImpl.h"
#include "ut_Xpm2Bmp.h"

class ABI_EXPORT XAP_Win32Dialog
{
public:
    virtual BOOL                    _onInitDialog(HWND hWnd, WPARAM wParam, LPARAM lParam) = 0;
    virtual BOOL                    _onCommand(HWND hWnd, WPARAM wParam, LPARAM lParam) = 0;
    virtual BOOL                    _onDeltaPos(NM_UPDOWN * pnmud) = 0;
};

class ABI_EXPORT XAP_Win32DialogHelper
{
public:
    XAP_Win32DialogHelper(XAP_Win32Dialog* p_dialog)
    :   m_pDialog(p_dialog),
        m_hDlg(0)
    {
    }

    // for plugin dialogs  - they have their own runModal and s_dlgProc due to differing hInstance values
    // (DLL instead of Abi main executable)
    // Makes more sense to share this code rather than use bare WinAPI in plugins when possible
    XAP_Win32DialogHelper(HWND hDlg)
    :   m_pDialog(0),
        m_hDlg(hDlg)
    {
    }


public:

    void                runModal(       XAP_Frame*              pFrame,
                                        XAP_Dialog_Id           dialog_id,
                                        UT_sint32               resource_id,
                                        XAP_Dialog*             p_dialog);

    void                 runModeless(   XAP_Frame*              pFrame,
                                        XAP_Dialog_Id           dialog_id,
                                        UT_sint32               resource_id,
                                        XAP_Dialog_Modeless*    p_dialog);

    static BOOL CALLBACK    s_dlgProc(  HWND    hWnd,
                                    UINT    msg,
                                    WPARAM  wParam,
                                    LPARAM  lParam);

    void                checkButton(UT_sint32 controlId, bool bChecked = true);
    void                enableControl(UT_sint32 controlId, bool bEnabled = true);
    void                destroyWindow();
    void                setDialogTitle(LPCSTR p_str);
    int             showWindow( int Mode );
    int             showControl(UT_sint32 controlId, int Mode);
    int             bringWindowToTop();

    // Combo boxes.

    int             addItemToCombo(UT_sint32 controlId, LPCSTR p_str);
    void                selectComboItem(UT_sint32 controlId, int index);
    int                 setComboDataItem(UT_sint32 controlId, int nIndex, DWORD dwData);
    int                 getComboDataItem(UT_sint32 controlId, int nIndex);
    int             getComboSelectedIndex(UT_sint32 controlId) const;
    void                resetComboContent(UT_sint32 controlId);

    // List boxes

    void                resetContent(UT_sint32 controlId);
    int             addItemToList(UT_sint32 controlId, LPCSTR p_str);
    int             getListSelectedIndex(UT_sint32 controlId) const;
    int                 setListDataItem(UT_sint32 controlId, int nIndex, DWORD dwData);
    int                 getListDataItem(UT_sint32 controlId, int nIndex);
    void                selectListItem(UT_sint32 controlId, int index);
    void                getListText(UT_sint32 controlId, int index, char *p_str) const;

    // Controls
    void                setControlText(UT_sint32 controlId, LPCSTR p_str);
    void                setControlInt(UT_sint32 controlId, int value);
    int             getControlInt(UT_sint32 controlId) const;

    void                selectControlText(UT_sint32 controlId,
                                          UT_sint32 start,
                                          UT_sint32 end);

    int             isChecked(UT_sint32 controlId) const;
    void                getControlText( UT_sint32   controlId,
                                        LPSTR       p_buffer,
                                        UT_sint32   Buffer_length) const;

    bool                isControlVisible(UT_sint32  controlId) const;

    bool                isParentFrame(/*const*/ XAP_Frame& frame) const;
    void                setParentFrame(const XAP_Frame* pFrame);
    XAP_Frame*          getParentFrame();
    void                centerDialog();
    static void         s_centerDialog(HWND hWnd);
    void                setHandle(HWND hWnd){m_hDlg=hWnd;};

private:
    XAP_Win32Dialog *           m_pDialog;
    HWND                        m_hDlg;
};


#endif /* XAP_Win32DialogHelper_H */