Reference » Window classes » MWindow » genNotice

Elgrint::MWindow::genNotice(MString) method

Declaration (see MWindow.h):

void genNotice(const MString& noticeName);

Description

Generates Notice message with the specified name and associated ID (as returned by getNoticeID).

Parameters:

Name Type Description
noticeName MString

The name of the Notice to generate.

Details

The function extracts a numeric notice ID, associated with noticeName for this window by a previous call to setNoticeID on this window.

If the associated ID is None, then genNotice has no effect - no notice is generated and no error is reported.

Since None is the default ID for all notices, setNoticeID has to be called at least once for genNotice to be useful. Many window classes call setNoticeID during their creation (the ID is usually specified in the window class constructor).

If the associated ID is anything but None, the function generates a Notice message, which is processed before genNotice returns. During this notice message processing, digNN returns noticeName, and digNID returns the ID extracted by genNotice (even if the actual associated ID changes in the process).

Remarks

Let us know

Please Contact us to report any errors on this page, or to suggest any improvements.

Miranor Home | About Miranor | About Elgrint | Create account | Login | Account settings | Contact Us | Privacy Policy | Site map

© Copyright 2014 by Miranor. All rights reserved. By using this site you agree to the Terms of Use.

Page last updated on August 10th, 2014.