message_box.h

Go to the documentation of this file.

#ifndef MESSAGE_BOX_CLASS
#define MESSAGE_BOX_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : message_box                                                       *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*  Purpose:                                                                   *
*                                                                             *
*    Displays a window on the screen with a message for the user and asks     *
*  whether a choice is okay or not.  The user's response is passed to         *
*  the event function button_event.                                           *
*                                                                             *
*******************************************************************************
* Copyright (c) 1991-$now By Author.  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 is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

#include "dll_wp_active.h"

#include <basis/istring.h>
#include <wp_passive/manager.h>
#include <wp_passive/worker.h>

enum message_box_kinds { PROCEED, INFORMATION, WARNING, HELP };
  // The different kinds of message boxes are:
  //
  //   PROCEED: displays a box with a single message and offers the user the
  //     three choices of YES, NO, or CANCEL.
  //
  //   INFORMATION: displays a window with a message inside of it.  the single
  //     button is labelled OKAY.
  //
  //   WARNING: displays a window with vital information inside of it.  warning
  //     dialogs require the user to accept the consequences of an action
  //     that they have selected (despite the warning message) as OKAY or
  //     to reject the consequences with CANCEL.
  //
  //   HELP: display an error message and offer the choice of OKAY or
  //     HELP which will pop up a brief help message.  after reading the
  //     message, the user must select OKAY.  The event function will be fired
  //     when either OKAY or HELP is pushed, but is not fired for the help
  //     message itself.

enum PROCEED_BUTTONS { PROCEED_YES, PROCEED_NO, PROCEED_CANCEL };
enum INFORMATION_BUTTONS { INFO_OKAY };
enum WARNING_BUTTONS { WARNING_OKAY, WARNING_CANCEL };
enum HELP_BUTTONS { HELP_OKAY, HELP_HELP };

class WP_ACTIVE_CLASS_STYLE message_box : public worker
{
public:
  message_box(manager &root, const c_point &origin, message_box_kinds kind,
          const char *message, const char *second_message = NIL,
          const color &foreground = colors::WHITE,
          const color &background = colors::BLACK);
    // creates a message for the user according to the "kind".  if the
    // parent is activated, the message will appear.  if the parent is
    // nil, then only the "show_box" function can cause the message_box
    // to appear.

  ~message_box();

  IMPLEMENT_CLASS_NAME("message_box");

  virtual void draw();

  virtual void button_event(int button_number);
    // This event function is invoked when the user presses one of the
    // buttons in the message box.

  static void message_box_callback(window_handle w, message_box *the_box,
          XmAnyCallbackStruct *call_data);

private:
  message_box_kinds _kind;
  istring _message;
  istring _second_message;
  int last_hit;
  message_box *extra_help_box;

  void hookup_callbacks();

  void setup_proceed_box();
  void setup_information_box();
  void setup_warning_box();
  void setup_help_box();
  void show_help();
};

#endif

---