QfCastle.H

/* QfCastle.H */
/* $Id: QfCastle.H,v 1.7 2004/01/23 11:54:33 vlad Exp $ */
#ifndef __QfCastle_H
#define __QfCastle_H

#include <zm/QfTower.H>


/***********************************************************************
 * Container of vertically constrained objects with rich decoration
 * features.
 */
class QfCastle: public QfTower
{
public:

  /* Create general container that is main master.  Phases 1-3 take
     place here. */
  QfCastle (Widget wParent,
        QfDecoration eDecor = QfDECOR_NONE,
        char* szResName = QfDIALOG_NAME);

  virtual ~QfCastle ();

  /*
   *  Decoration.
   */

  /* Window title. */
  void  set_title (const char* szTitle);

  /* Set help section reference. */
  void  set_help_section (const char* szSectionRef);

  /* Set help document pointer. */
  void  set_help_doc (const char* szURL);

  /*
   *  Actions functionality.
   */

  /* Add action buttons. */
  virtual void  add_actions (QfActionsMask amask,
                 QfDecoration eDecor = QfDECOR_NONE);

  /* Get flag of running. */
  Logic     is_running () const;

  /* Get reverted flag of running. */
  Logic     is_stopped () const;


  /*
   *  Open/close/check dialog window.
   */

  /* Reliable check for dialog existance. */
  Logic     is_dialog_alive ();

  /* Display modeless dialog. */
  virtual void  manage (QfWindowPlacement wpl = QfWINPLACE_DEFAULT);

  /* Display modal dialog. */
  virtual void  manage_modal (QfWindowPlacement wpl = QfWINPLACE_DEFAULT);

  /* Operation of closing dialog (not to destruct, but only to hide). */
  virtual void  close_dialog ();

  /*
   *  Event processing control.
   */

  /* Full time Xt event processing until user window_close action.
     See close_reason_button(). */
  virtual void  loop_events ();

  /* Partial time Xt event processing (up to N events for one call).
     See close_reason_button(). */
  virtual void  process_events (int n = QfEVENTS_QUANT);

  /* Returns id of the standard button that cause exit of the dialog. */
  virtual QfActionButtonId  close_reason_button () const;


  /*
   *  These methods are called on corresponding button press.
   *  Make expected things by default.
   */

  /* "OK" button pressed.  Store GUI values and close dialog. */
  virtual void  ok_button ();

  /* "Apply" button pressed.  Store GUI values. */
  virtual void  apply_button ();

  /* "Close" button pressed.  Synonymous to "Cancel" button. */
  virtual void  close_button ();

  /* "Cancel" button pressed.  Close dialog. */
  virtual void  cancel_button ();

  /* "Undo" button pressed.  Load values in GUI items. */
  virtual void  undo_button ();

  /* "Help" button pressed.  Call for document by vsStartViewer(). */
  virtual void  help_button ();

  /* "Run" button pressed.  Store GUI values, make all elements
     unsensitive except "Stop", "Help", "Cancel" and run pRunProc. */
  virtual void  run_button ();

  /* "Stop" button pressed.  Restore GUI values, make sensitive all
     elements and call pStopProc. */
  virtual void  stop_button ();

protected:

  Widget    wTower;     /* QfTower main widget. */
  Widget    wTempForm;  /* Intermediate container XmForm reference. */
  Widget    wShell;     /* =wSelf, XmDialogShell widget reference. */

  /* Section reference for context help */
  char      *szHelpRef;

  /* TRUE if dialog is popped up and FALSE otherwise. */
  Logic     bActivity;

  /* TRUE if user pressed "Run" and not pressed "Stop" or "Cancel". */
  Logic     bRunning;

  /* Array of pointers at buttons objects */
  QfBrick   *pButtons[QfA_ButtonsNumber];

  /* Id of the button that cause exit from loop_event() */
  QfActionButtonId  eButton;

  /* Empty due to QfCastle is always main master. */
  virtual void  create_self (Widget wParent);

  /* Callback on destroy. */
  static void   wm_delete_cb (Widget w, XtPointer pUserData,
                  XtPointer pCallData);

  /* Button action procs. */
  static void   ok_action_proc (void* pUserData);
  static void   apply_action_proc (void* pUserData);
  static void   close_action_proc (void* pUserData);
  static void   cancel_action_proc (void* pUserData);
  static void   help_action_proc (void* pUserData);
  static void   undo_action_proc (void* pUserData);
  static void   run_action_proc (void* pUserData);
  static void   stop_action_proc (void* pUserData);

  /* Common manage procedure */
  void      manage_with_style (int dialog_style);

  /* Window placement procedure relative to parent window */
  void      place_window (QfWindowPlacement wpl);

};


#endif /* QfCastle.H */