Skip to content

Latest commit

 

History

History
341 lines (175 loc) · 9.49 KB

PyCPropertyPage.md

File metadata and controls

341 lines (175 loc) · 9.49 KB

PyCPropertyPage

PyCPropertyPage Object

A class which encapsulates an MFC CPropertyPage object. Derived from a PyCDialog object.

Methods

  • CancelToClose

    Changes the Cancel button to Close. 

  • OnCancel

    Calls the default MFC OnCancel handler. 

  • OnOK

    Calls the default MFC OnOK handler. 

  • OnApply

    Calls the default MFC OnApply handler. 

  • OnReset

    Calls the default MFC OnReset handler. 

  • OnQueryCancel

    Calls the default MFC OnQueryCancel handler. 

  • OnWizardBack

    Calls the default MFC OnWizardBack handler. 

  • OnWizardNext

    Calls the default MFC OnWizardNext handler. 

  • OnWizardFinish

    Calls the default MFC OnWizardFinish handler. 

  • OnSetActive

    Calls the default MFC OnSetActive handler. 

  • OnKillActive

    Calls the default MFC OnKillActive handler. 

  • SetModified

    Sets the modified flag (for the Apply button). 

  • SetPSPBit

    Sets (or clears) a bit in m_psp.dwFlags. 

PyCPropertyPage.CancelToClose

CancelToClose() Changes the Cancel button to Close.

PyCPropertyPage.OnApply

OnApply() Calls the default MFC OnApply handler.

See Also

PyCPropertyPage.OnApply Virtual

OnApply() Called by the framework when the user chooses the OK or the Apply Now button.

Comments

Note - If you provide a handler, you must call the underlying MFC method (PyCPropertyPage::OnApply) yourself

See Also

Return Value

Return Nonzero if the changes are accepted; otherwise 0.

PyCPropertyPage.OnCancel

OnCancel() Calls the default MFC OnCancel handler.

See Also

PyCPropertyPage.OnKillActive

int = OnKillActive() Calls the default MFC OnKillActive handler.

See Also

Return Value

The result is true if the page should be deselected.

Typically this result should be passed to the original OnSetActive handler.

PyCPropertyPage.OnKillActive Virtual

OnKillActive() Called when the page loses focus.

Comments

Note - If you provide a handler, you must call the underlying MFC method (PyCPropertyPage::OnKillActive) yourself

See Also

Return Value

The method should return TRUE if the page can be de-activated.

PyCPropertyPage.OnOK

OnOK() Calls the default MFC OnOK handler.

See Also

PyCPropertyPage.OnQueryCancel

OnQueryCancel() Calls the default MFC OnQueryCancel handler.

See Also

PyCPropertyPage.OnQueryCancel Virtual

OnQueryCancel() Called by the framework when the user clicks the Cancel button and before the cancel action has taken place.

Comments

Note - If you provide a handler, you must call the underlying MFC method (PyCPropertyPage::OnQueryCancel) yourself

See Also

Return Value

Return FALSE to prevent the cancel operation or TRUE to allow it.

PyCPropertyPage.OnReset

OnReset() Calls the default MFC OnReset handler.

See Also

PyCPropertyPage.OnReset Virtual

OnReset() Called by the framework when the user chooses the Cancel button.

Comments

Note - If you provide a handler, you must call the underlying MFC method (PyCPropertyPage::OnReset) yourself

See Also

PyCPropertyPage.OnSetActive

int = OnSetActive() Calls the default MFC OnSetActive handler.

See Also

Return Value

The result is true if the page should be made active.

Typically this result should be passed to the original OnSetActive handler.

PyCPropertyPage.OnSetActive Virtual

OnSetActive() Called when the page becomes active.

Comments

Note - If you provide a handler, you must call the underlying MFC method (PyCPropertyPage::OnSetActive) yourself

See Also

Return Value

The method should return TRUE if the page can be activated.

PyCPropertyPage.OnWizardBack

OnWizardBack() Calls the default MFC OnWizardBack handler.

See Also

PyCPropertyPage.OnWizardBack Virtual

OnWizardBack() Called by the framework when the user clicks on the Back button in a wizard.

Comments

Note - If you provide a handler, you must call the underlying MFC method (PyCPropertyPage::OnWizardBack) yourself

See Also

Return Value

Return 0 to automatically advance to the next page; -1 to prevent the page from changing. To jump to a page other than the next one, return the identifier of the dialog to be displayed.

PyCPropertyPage.OnWizardFinish

OnWizardFinish() Calls the default MFC OnWizardFinish handler.

See Also

PyCPropertyPage.OnWizardFinish Virtual

OnWizardFinish() Called by the framework when the user clicks on the Finish button in a wizard.

Comments

Note - If you provide a handler, you must call the underlying MFC method (PyCPropertyPage::OnWizardFinish) yourself

See Also

Return Value

Return nonzero if the property sheet is destroyed when the wizard finishes; otherwise zero.

PyCPropertyPage.OnWizardNext

OnWizardNext() Calls the default MFC OnWizardNext handler.

See Also

PyCPropertyPage.OnWizardNext Virtual

OnWizardNext() Called by the framework when the user clicks on the Next button in a wizard.

Comments

Note - If you provide a handler, you must call the underlying MFC method (PyCPropertyPage::OnWizardNext) yourself

See Also

Return Value

Return 0 to automatically advance to the next page; -1 to prevent the page from changing. To jump to a page other than the next one, return the identifier of the dialog to be displayed.

PyCPropertyPage.SetModified

SetModified(bChanged) Sets the modified flag.

Parameters

  • bChanged=1 : int

    A flag to indicate the new modified state.

PyCPropertyPage.SetPSPBit

SetPSPBit(bitMask, bitValue) Sets or clears a bit in m_psp.dwFlags

Parameters

  • bitMask : int

    The PSP_* bit mask constant

  • bitValue : int

    1 to set, 0 to clear