ZtMain.H

// ZtMain.H     $Revision: 1.13 $   $Date: 2004/10/07 14:01:36 $ 

#if !defined __ZtMain_H

#define __ZtMain_H

#include <zm/InfoLine.H>

#include <zm/ZPixelCoord.H>
#include <zm/ZNaturalCoord.H>
#include <zm/ZtObject.H>


/*************************************************************
 * Two pixel groups describe the whole box of main window.
 * They have special group ids:
 *************************************************************/
#define WHOLE_BOX_ID    0
#define WHOLE_WIDTH_ID  WHOLE_BOX_ID
#define WHOLE_HEIGHT_ID WHOLE_BOX_ID


/*************************************************************
 * Center of control under vertical and horizontal pixel and
 * natural groups.
 *************************************************************/

#define PtrType     ZtObject*
#define PtrAr       ZtObjAr
#include <mix/PtrAr.H>  /* ==> class ZtObjAr */

class ZtMain
  : public ZWindow
#ifndef NO_XTOOLKIT
  , public ZWidget
#endif /* NO_XTOOLKIT */
{
public:

  ZPCoordMaster *mpx;    /* Controls horizontal pixel groups */
  ZPCoordMaster *mpy;    /* Controls vertical pixel groups */

  ZNCoordMaster *mnx;    /* Controls horizontal natural groups */
  ZNCoordMaster *mny;    /* Controls vertical natural groups */

  ZtMain (const ZConnect& zconnect, Window window);
  ZtMain (const ZWindow& zwindow);
#ifndef NO_XTOOLKIT
  ZtMain (const ZWidget& zwidget);
#endif /* NO_XTOOLKIT */
  virtual ~ZtMain ();

  /* Add object at the top of drawing list */
  void      add (const ZtObject* pObject);

  /* Returns count of objects */
  int       objects_count () const;

  /* Put object at the top of drawing list */
  void      raise_exch (int iObject);
  void      raise_shift (int iObject);

  /* Get index of object by pointer or (-1) if no such object */
  int       object_index (const ZtObject* pObject) const;

  /* Delete object from drawing list by index and by pointer */
  void      remove (int iObject);
  void      remove (const ZtObject* pObject);

  /* Hide object (don't draw it) by index */
  void      hide (int iObject);

  /* Show object (don't draw it) by index */
  void      show (int iObject);

  /* Return TRUE if object is hidden */
  Logic     is_hidden (int iObject) const;

  /* Get pointer at object by its index or NULL if no such index */
  ZtObject* object_pointer (int iObject) const;
  ZtObject& operator[] (int iObject) const;

  /* Exposure procedure is called when resize or expose event is take
     place */
  virtual void  expose ();

  virtual void  redraw ();

  /* Draw image to TIFF file */
  virtual void  draw_to_tiff (const char* path);

  virtual void  draw_to_pixmap (ZArea& pixmap);

  /* Event processing for all objects with final status:
     ziProcessed - if event processing has been finished (ungrab input);
     ziGrabInput - if event processing must be continued (grab input);
     ziSkipped - if this event is not processed. */
  virtual ZInputStatus  input (const XEvent* xev);

  /* Set mode of expose: with buffered pixmap (TRUE) or without (FALSE) */
  void      seldom_redraw (Logic flag);

  /* Get mode of expose: with buffered pixmap (TRUE) or without (FALSE) */
  Logic     is_seldom_redraw () const;

#ifdef NO_XTOOLKIT
  /* Return NULL only if no XToolkit code is allowed */
  virtual Widget    widget () const;
#endif /* NO_XTOOLKIT */

  /***********************************************************************
   * Special facility for window-local user messages
   ***********************************************************************/

  void      set_info_lines (InfoLine* il);

  InfoLine* get_info_lines () const;

protected:/* data */

  InfoLine  *pInfoLine;

protected:

  /* Direct drawing procedure to pointed drawable */
  virtual void  draw_to (Drawable d, const ZSize& s);

  Logic     cache_is_actual () const;

  ZArea     *cached_area;   
  ZtObjAr   *objects;   
  int       iGrabInput; 
private:

  void      init ();

  Logic     seldom_flag;

};


/*************************************************************
 * INLINES
 *************************************************************/

/*************************************************************
 * Get mode of expose: with buffered pixmap (TRUE) or without
 * (FALSE)
 */
inline Logic
ZtMain::is_seldom_redraw () const
{
  return seldom_flag;
}

#ifdef NO_XTOOLKIT
/*************************************************************
 * Return NULL only if no XToolkit code is allowed.
 * Usually widget() is inherited from ZWidget.
 */
inline Widget
ZtMain::widget () const
{
  return NULL;
}
#endif /* NO_XTOOLKIT */


#endif  // ZtMain.H