dialog_window.h

Go to the documentation of this file.

//      _  _         _                             _             _                  _      //
//   __| |(_)  __ _ | |  ___    __ _    __      __(_) _ __    __| |  ___ __      __| |__   //
//  / _` || | / _` || | / _ \  / _` |   \ \ /\ / /| || '_ \  / _` | / _ \\ \ /\ / /| '_ \  //
// | (_| || || (_| || || (_) || (_| |    \ V  V / | || | | || (_| || (_) |\ V  V /_| | | | //
//  \__,_||_| \__,_||_| \___/  \__, |_____\_/\_/  |_||_| |_| \__,_| \___/  \_/\_/(_)_| |_| //
//                             |___/|_____|                                                //
//                                                                                         //
//                  modal or modeless window based on a dialog template                    //
//                                                                                         //

/*****************************************************************************

    X11workbench - X11 programmer's 'work bench' application and toolkit
    Copyright (c) 2010-2019 by Bob Frazier (aka 'Big Bad Bombastic Bob')


  DISCLAIMER:  The X11workbench application and toolkit software are supplied
               'as-is', with no warranties, either implied or explicit.
               Any claims to alleged functionality or features should be
               considered 'preliminary', and might not function as advertised.

  MIT-like license:

  There is no restriction as to what you can do with this software, so long
  as you include the above copyright notice and DISCLAIMER for any distributed
  work that is equal to or derived from this one, along with this paragraph
  that explains the terms of the license if the source is also being made
  available.  A "derived work" describes a work that uses a significant portion
  of the source files or algorithms that are included with this one.
  Specifically excluded from this are files that were generated by the software,
  or anything that is included with the software that is part of another package
  (such as files that were created or added during the 'configure' process).
  Specifically included is the use of part or all of any of the X11 workbench
  toolkit source or header files in your distributed application.  If you do not
  ship the source, the above copyright statement is still required to be placed
  in a reasonably prominent place, such as documentation, splash screens, and/or
  'about the application' dialog boxes.

  Use and distribution are in accordance with GPL, LGPL, and/or the above
  MIT-like license.  See COPYING and README files for more information.


  Additional information at http://sourceforge.net/projects/X11workbench

******************************************************************************/


#ifndef DIALOG_WINDOW_H_INCLUDED
#define DIALOG_WINDOW_H_INCLUDED

#include "window_helper.h"

#ifdef __cplusplus
extern "C" {
#endif // __cplusplus


#define DIALOG_WINDOW_TAG (*((const unsigned int *)"DLGW")) 
#define DIALOG_ENTRY_TAG (*((const unsigned int *)"DLGE"))  
typedef struct s_WB_DIALOG_ENTRY
{
  unsigned int ulTag; 
  Window wID;         
  Atom aClass;        
  int iID;            
  int iFlags;         
  int iX,             
      iY,             
      iWidth,         
      iHeight;        

} WBDialogEntry;


typedef struct s_WB_DIALOG_WINDOW
{
  unsigned int ulTag;    
  Window wID;            
  Window wIDOwner;       
  void *pUserData;       
  int iFlags;            
  int iClientX,          
      iClientY,          
      iClientWidth,      
      iClientHeight;     
  XColor clrFG,          
         clrBG,          
         clrBD;          
} WBDialogWindow;

enum WBDialogWindowFlags
{
  WBDialogWindow_APP_WINDOW  = 1,
  WBDialogWindow_VISIBLE     = 2,
  WBDialogWindow_DOMODAL     = 4,
  WBDialogWindow_CENTERMOUSE = 8,
  WBDialogWindow_HRESIZE     = 0x100,
  WBDialogWindow_VRESIZE     = 0x200,

  WBDialogWindow_MAX = 0x80000000L
};

enum WBDialogEntryFlags
{
  WBDialogEntry_VISIBLE         = 0x00000001,  
  WBDialogEntry_EDIT            = 0x00000002,  
  WBDialogEntry_MULTILINE       = 0x00000004,  
  WBDialogEntry_ALLCHARS        = 0x00000008,  

  WBDialogEntry_TRISTATE        = 0x00000010,  
  WBDialogEntry_CHECKED         = 0x00000020,  
  WBDialogEntry_NO_BORDER       = 0x00000040,  

  // text alignment (in caption or body of control, when applicable)
  WBDialogEntry_VA_TEXT_CENTER  = 0x00000000,  
  WBDialogEntry_VA_TEXT_TOP     = 0x00000100,  
  WBDialogEntry_VA_TEXT_BOTTOM  = 0x00000200,  
  WBDialogEntry_VA_TEXT_MASK    = 0x00000300,  
  WBDialogEntry_HA_TEXT_LEFT    = 0x00000000,  
  WBDialogEntry_HA_TEXT_CENTER  = 0x00000400,  
  WBDialogEntry_HA_TEXT_RIGHT   = 0x00000800,  
  WBDialogEntry_HA_TEXT_MASK    = 0x00000c00,  
  WBDialogEntry_ALIGN_TEXT_MASK = 0x00000f00,  


// TODO:  other user-definable flags


// the remaining bits are reserved for internal use

  // TODO:  others

  // control alignment flags - these match the 'CONTROL_' bit flags in dialog_controls.h

  WBDialogEntry_HResize         = 0x00040000, 
  WBDialogEntry_VResize         = 0x00080000, 
  WBDialogEntry_ResizeMask      = 0x000c0000, 

  WBDialogEntry_VAlignFixed     = 0x00000000, 
  WBDialogEntry_VAlignTop       = 0x00100000, 
  WBDialogEntry_VAlignBottom    = 0x00200000, 
  WBDialogEntry_VAlignCenter    = 0x00300000, 
  WBDialogEntry_VAlignMask      = 0x00300000, 

  WBDialogEntry_HAlignFixed     = 0x00000000, 
  WBDialogEntry_HAlignLeft      = 0x00400000, 
  WBDialogEntry_HAlignRight     = 0x00800000, 
  WBDialogEntry_HAlignCenter    = 0x00c00000, 
  WBDialogEntry_HAlignMask      = 0x00c00000, 
  WBDialogEntry_AlignMask       = 0x00f00000, 


  WBDialogEntry_Reserved24      = 0x01000000, 
  WBDialogEntry_Reserved25      = 0x02000000, 
  WBDialogEntry_DISABLED        = 0x04000000, 
  WBDialogEntry_PRESSED         = 0x08000000, 

  // focus and 'default' flags

  WBDialogEntry_CAN_HAVE_FOCUS  = 0x10000000, 
  WBDialogEntry_HAS_FOCUS       = 0x20000000, 
  WBDialogEntry_PUSHBUTTON      = 0x40000000, 
  WBDialogEntry_DEFAULT         = 0x80000000  

};

WBDialogWindow *DLGCreateDialogWindow(Window wIDOwner, const char *szTitle,
                                      const char *szDialogResource,
                                      int iX, int iY, int iWidth, int iHeight,
                                      WBWinEvent pUserCallback, int iFlags,
                                      void *pUserData);

void DLGAssignOwner(WBDialogWindow *pDlg, Window wIDOwner);

void DLGRecalcLayout(Window wID);  // recalculate layout information (propagates to children)

int DLGPixelHeight(WBDialogWindow *pDlg, int iHeight);  // pixel height from dialog units

int DLGPixelWidth(WBDialogWindow *pDlg, int iWidth);    // pixel width from dialog units


void DLGSetUserCallback(WBDialogWindow *pDLG, WBWinEvent pCallBack);
  // assigns the user-defined callback function (one only).  Not all messages pass through the callback

int DLGProcessHotKey(WBDialogWindow *pDLG, XEvent *pEvent);
  // returns non-zero value if hot-key was processed and no further event processing
  // should be performed.  Otherwise returns zero.  Default dialog callback handles this
  // automatically (as does the default dialog control callback, when applicable).


static __inline__ WBDialogWindow *DLGGetDialogWindowStruct(Window wID)  // for dialog windows, returns WBDialogWindow struct
{
  WBDialogWindow *pRval = (WBDialogWindow *)WBGetWindowData(wID, 0);  // offset 0 for window-specific structs

  if(pRval && DIALOG_WINDOW_TAG == pRval->ulTag)
  {
    return(pRval);
  }

//  if(pRval && pRval->ulTag != DIALOG_WINDOW_TAG)
//  {
//    WB_ERROR_PRINT("ERROR:  DLGGetDialogWindowStruct, bad tag: %08xH %08xH\n", DIALOG_WINDOW_TAG, pRval->ulTag);
//  }
//  else // if(!pRval)
//  {
//    WB_ERROR_PRINT("ERROR:  DLGGetDialogWindowStruct - pointer is NULL\n");
//  }

  return(NULL);
}

void * DLGGetDialogWindowUserData(Window wID);

void DLGDestroyDialogWindow(Window wID);

void DLGDestroyDialogWindow2(WBDialogWindow *pDialogWindow);



// control query and enumeration

Window DLGGetDialogControl(WBDialogWindow *pDialog, int iControlID);  // returns first match

WBDialogEntry *DLGGetDialogControlEntry(WBDialogWindow *pDialog, Window idControl);  // returns matching WBDialogEntry

Window DLGGetFirstDialogControl(WBDialogWindow *pDialog);  // first dialog control in tab order
Window DLGGetNextDialogControl(WBDialogWindow *pDialog, Window idControl);  // control following wIDControl

Window DLGGetPrevDialogControl(WBDialogWindow *pDialog, Window idControl);  // control prior to wIDControl
  // NOTE:  'GetNext' and 'GetPrev' wrap around and may return the same window ID


// POSTING AND SENDING NOTIFICATION MESSAGES

static __inline__ void DLGNotifyDlg(WBDialogWindow *pDLG, Atom aNotify,
                                    long lData0, long lData1, long lData2, long lData3, long lData4)
{
Display *pDisplay = WBGetWindowDisplay(pDLG->wID);

  XClientMessageEvent evt = {
                              .type=ClientMessage,
                              .serial=0,
                              .send_event=0,
                              .display=pDisplay,
                              .window=pDLG->wID,
                              .message_type=aNotify,
                              .format=32
                            };
  evt.data.l[0] = lData0;
  evt.data.l[1] = lData1;
  evt.data.l[2] = lData2;
  evt.data.l[3] = lData3;
  evt.data.l[4] = lData4;

  WBWindowDispatch(pDLG->wID, (XEvent *)&evt);
}


static __inline__ void DLGNotifyDlgAsync(WBDialogWindow *pDLG, Atom aNotify,
                                         long lData0, long lData1, long lData2, long lData3, long lData4)
{
Display *pDisplay = WBGetWindowDisplay(pDLG->wID);

  XClientMessageEvent evt = {
                              .type=ClientMessage,
                              .serial=0,
                              .send_event=0,
                              .display=pDisplay,
                              .window=pDLG->wID,
                              .message_type=aNotify,
                              .format=32
                            };
  evt.data.l[0] = lData0;
  evt.data.l[1] = lData1;
  evt.data.l[2] = lData2;
  evt.data.l[3] = lData3;
  evt.data.l[4] = lData4;

  WBPostPriorityEvent(pDLG->wID, (XEvent *)&evt);
}



// special pre-defined dialog windows

enum MessageBoxEnum
{
    MessageBox_Error=0,              
    MessageBox_Warning=1,            
    MessageBox_Info=2,               
    MessageBox_Asterisk=3,           
    MessageBox_Question=4,           
    MessageBox_BoldQuestion=5,       
    MessageBox_WTF=6,                
    MessageBox_Bang=7,               
    MessageBox_Triangle=8,           
    MessageBox_FaceOfDeath=9,        
    MessageBox_JollyRoger=10,        
    MessageBox_ThumbsUp=11,          
    MessageBox_ThumbsDown=12,        
    MessageBox_MiddleFinger=13,      
    MessageBox_TeddyBear=14,         
    MessageBox_Barney=15,            
    MessageBox_App=16,               

    MessageBox_ICON_MASK = 0x1f,     

    // 'or' with one or more button types (none implies 'ok' by itself)
    // NOTE: left-right ordering by numeric value (lowest is left-most)

    MessageBox_Default     = 0,      

    MessageBox_OK          = 0x20,   
    MessageBox_Yes         = 0x40,   
    MessageBox_No          = 0x80,   
    MessageBox_Abort       = 0x100,  
    MessageBox_Retry       = 0x200,  
    MessageBox_Ignore      = 0x400,  
    MessageBox_Cancel      = 0x800,  

    // legal multi-bit combinations
    MessageBox_OKCancel         = 0x820,  
    MessageBox_YesNo            = 0xc0,   
    MessageBox_YesNoCancel      = 0x8c0,  
    MessageBox_AbortRetry       = 0x500,  
    MessageBox_AbortRetryIgnore = 0x700,  

    MessageBox_BUTTON_MASK = 0xfe0   
};

int DLGMessageBox(int iType, Window wIDOwner, const char *szTitle, const char *szMessage);

char *DLGInputBox(Window wIDOwner, const char *szTitle, const char *szPrompt, const char *szDefault,
                  int iWidth, int iMaxChar);


enum FileDialogEnum
{
    FileDialog_Open = 0,    
    FileDialog_Save = 1,    
    FileDialog_SaveAs = 2,  
    FileDialog_Folder = 3,  
    FileDialog_MASK = 0xf,  

    // modifications
    FileDialog_ReadOnly = 0x10,           
    FileDialog_NoOverwrite = 0x20,        
    FileDialog_NoOverwritePrompt = 0x40,  
    FileDialog_NoFolderNav = 0x80,        
    FileDialog_Simple = 0x100,            

    FileDialog_MODIFIER_MASK = 0xff0      
};

char *DLGFileDialog(int iType, Window wIDOwner, const char *szDefPath, const char *szDefName,
                    const char *szExtAndDescList);


int DLGColorDialog(Window wIDOwner, XStandardColormap *pColorMap, XColor *pColor);


WB_FONT DLGFontDialog(Display *pDisplay, Window wIDOwner, WB_FONTC pDefault);


void DLGSplashScreen(char * aXPM[], const char *szCopyright, unsigned long clrText);


#ifdef __cplusplus
};
#endif // __cplusplus


#endif // DIALOG_WINDOW_H_INCLUDED