The V C++ GUI Framework:vNoticeDialog

From EDM2
Jump to: navigation, search

A utility class to display a message.

Synopsis

Header:
<v/vnotice.h>
Class name:
vNoticeDialog
Hierarchy:
vModalDialog ->vNoticeDialog

Description

This simple utility class can be used to display a simple message to the user. The utility displays the message, and then waits for the user to enter to press OK.

New Methods

vNoticeDialog(vBaseWindow* win)

vNoticeDialog(vApp* app)

The vNoticeDialog constructor requires a pointer to a vBaseWindow, which includes all V windows and dialogs, or a pointer to the vApp object. You will usually pass the this to the constructor.

void Notice(const char* prompt)

You provide a prompt for the user. If the message contains 'backslashn' newlines, it will be shown on multiple lines.

Example

The following is a simple example of using vNoticeDialog.

V-gui-notice.gif

    #include <v/vnotice.h>
    ...
    vNoticeDialog note(this);   // instantiate a notice

    (void)note.Notice("This is a notice.");