Logo    
KDWinUtils
Helper library for MFC to Qt migration
Loading...
Searching...
No Matches
KDialog Class Reference

The KDialog class is used to replace MFC KDialog. More...

#include <kdialog.h>

Inheritance diagram for KDialog:
[legend]
Collaboration diagram for KDialog:
[legend]

Public Member Functions

 KDialog (CWnd *pParent, Qt::WindowFlags f={})
 
 KDialog (QWidget *pParent=nullptr, Qt::WindowFlags f={})
 
virtual bool OnInitDialog ()
 Initializes the dialog internal data.
 
- Public Member Functions inherited from KWidgetBase< QDialog >
virtual bool Create (const KString &lpszWindowName, Flags dwStyle, const KRect &rect, QWidget *pParentWnd)
 Creates and initializes the child window associated with the CWnd object.
 
void DestroyWindow ()
 Asks for deletion of the widget.
 
bool eventFilter (QObject *watched, QEvent *event) override
 
void GetClientRect (KRect *rect) const
 Gets the dimensions of the widget.
 
GetParent () const
 Retrieves the parent object of the widget, requires to pass the type of the parent.
 
KDialogGetParentDialog () const
 Retrieves the parent widget as a KDialog. Returns nullptr if it's not a KDialog.
 
KWidgetGetParentWidget () const
 Retrieves the parent widget as a KWidget. Returns nullptr if it's not a KWidget.
 
bool GetScrollInfo (Qt::Orientation nBar, ScrollInfo *lpScrollInfo, ScrollMasks nMask=ScrollMask::All)
 Retrieves the information that the ScrollInfo structure maintains about a scroll bar.
 
int GetScrollLimit (Qt::Orientation nBar)
 Retrieves the limit of the scroll bar.
 
int GetScrollPos (Qt::Orientation nBar) const
 Retrieves the current position of a scroll box.
 
void GetScrollRange (Qt::Orientation nBar, int *lpMinPos, int *lpMaxPos) const
 Copies the current minimum and maximum scroll-bar positions for the given scroll bar.
 
void GetWindowRect (KRect *rect) const
 Gets the screen coordinates of widget.
 
virtual void OnHelp ()
 Handles F1 Help within the application (using the current context).
 
bool PostMessage (unsigned int id, uint64_t wParam=0, int64_t lParam=0)
 Places a message in the application event loop, then returns without waiting for the window to process the message.

 
int64_t SendMessage (unsigned int id, uint64_t wParam=0, int64_t lParam=0)
 Sends a message to the object and does not return until it has processed the message.
 
void setFlag (Flag flag, bool on=true)
 Sets some flags on the widget.
 
bool SetScrollInfo (Qt::Orientation nBar, ScrollInfo *lpScrollInfo, bool bRedraw=true)
 Sets information about the scroll bar.
 
int SetScrollPos (Qt::Orientation nBar, int nPos, bool bRedraw=true)
 Sets the current position of a scroll box and, if specified, redraws the scroll bar to reflect the new position.
 
void SetScrollRange (Qt::Orientation nBar, int nMinPos, int nMaxPos, bool bRedraw=true)
 Sets minimum and maximum position values for the given scroll bar.
 
 ~KWidgetBase ()
 

Protected Member Functions

void closeEvent (QCloseEvent *event) override
 
virtual void OnCancel ()
 Override to perform the Cancel button or ESC key action.
 
virtual void OnClose ()
 Called just before closing the dialog box.
 
virtual void OnOK ()
 Override to perform the OK button action in a modal dialog box.
 
void showEvent (QShowEvent *event) override
 
- Protected Member Functions inherited from KWidgetBase< QDialog >
void connectKillFocus (QWidget *w, Class *object, void(Class::*method)())
 
void connectKillFocus (QWidget *w, FocusHandler method)
 
void connectMessage (int id, Class *object, int64_t(Class::*method)(uint64_t, int64_t))
 
void connectMessage (int id, MessageHandler method)
 
void connectRange (const typename QtPrivate::FunctionPointer< Signal >::Object *firstWidget, const typename QtPrivate::FunctionPointer< Signal >::Object *lastWidget, Signal signal, Class *object, void(Class::*method)(unsigned int))
 
void connectScroll (QAbstractSlider *abstractSlider)
 
bool event (QEvent *e) override
 
void keyPressEvent (QKeyEvent *event) override
 
void keyReleaseEvent (QKeyEvent *event) override
 
void mouseDoubleClickEvent (QMouseEvent *event) override
 
void mouseMoveEvent (QMouseEvent *event) override
 
void mousePressEvent (QMouseEvent *event) override
 
void mouseReleaseEvent (QMouseEvent *event) override
 
virtual void OnDestroy ()
 Called when widget is being destroyed.
 
virtual bool OnHelpInfo (QKeyEvent *event)
 Called by the framework when the user presses the F1 key.
 
virtual void OnHScroll (int nSBCode, int nPos, QAbstractSlider *pScroll)
 Called when the user clicks the horizontal scroll bar.
 
virtual void OnKeyDown (QKeyEvent *event)
 Called when a key is pressed.
 
virtual void OnKeyUp (QKeyEvent *event)
 Called when a key is released.
 
virtual void OnLButtonDblClk (QMouseEvent *event)
 Called when the user double-clicks the left mouse button.
 
virtual void OnLButtonDown (QMouseEvent *event)
 Called when the user presses the left mouse button.
 
virtual void OnLButtonUp (QMouseEvent *event)
 Called when the user releases the left mouse button.
 
virtual void OnMButtonDblClk (QMouseEvent *event)
 Called when the user double-clicks the middle mouse button.
 
virtual void OnMButtonDown (QMouseEvent *event)
 Called when the user presses the middle mouse button.
 
virtual void OnMButtonUp (QMouseEvent *event)
 Called when the user releases the middle mouse button.
 
virtual void OnMouseMove (QMouseEvent *event)
 Called when the mouse cursor moves.
 
virtual void OnPaint (QPaintEvent *event)
 Called to repaint a portion of the window.
 
virtual void OnRButtonDblClk (QMouseEvent *event)
 Called when the user double-clicks the right mouse button.
 
virtual void OnRButtonDown (QMouseEvent *event)
 Called when the user presses the right mouse button.
 
virtual void OnRButtonUp (QMouseEvent *event)
 Called when the user releases the right mouse button.
 
virtual void OnSize (QResizeEvent *event)
 Called after the size of CWnd has changed.
 
virtual void OnVScroll (int nSBCode, int nPos, QAbstractSlider *pScroll)
 Called when the user clicks the vertical scroll bar.
 
void paintEvent (QPaintEvent *event) override
 
void resizeEvent (QResizeEvent *event) override
 

Additional Inherited Members

- Public Types inherited from KWidgetBase< QDialog >
enum  Flag
 
enum  ScrollMask
 
- Static Public Attributes inherited from KWidgetBase< QDialog >
static constexpr char mfcIDProperty []
 
- Protected Types inherited from KWidgetBase< QDialog >
using FocusHandler
 
using MessageHandler
 

Detailed Description

Constructor & Destructor Documentation

◆ KDialog() [1/2]

KDialog::KDialog ( QWidget * pParent = nullptr,
Qt::WindowFlags f = {} )
explicit

Constructs a KDialog with a QWidget as parent.

◆ KDialog() [2/2]

KDialog::KDialog ( CWnd * pParent,
Qt::WindowFlags f = {} )

Constructs a KDialog with a MFC CWnd as parent. This is using a QWinWidget to create the parent-child relationship.

Member Function Documentation

◆ closeEvent()

void KDialog::closeEvent ( QCloseEvent * event)
overrideprotected

◆ OnCancel()

virtual void KDialog::OnCancel ( )
protectedvirtual

Override to perform the Cancel button or ESC key action.

The default closes the dialog box and exec returns QDialog::Rejected.

◆ OnClose()

virtual void KDialog::OnClose ( )
protectedvirtual

Called just before closing the dialog box.

In order for the dialog to close, the OnClose method must call the base class's OnClose method.

◆ OnInitDialog()

virtual bool KDialog::OnInitDialog ( )
inlinevirtual

Initializes the dialog internal data.

This method is not called during the construction, but only the first time the dialog is displayed.

◆ OnOK()

virtual void KDialog::OnOK ( )
protectedvirtual

Override to perform the OK button action in a modal dialog box.

The default closes the dialog box and exec returns QDialog::Accepted.

◆ showEvent()

void KDialog::showEvent ( QShowEvent * event)
overrideprotected

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