child_frame.h

Go to the documentation of this file.

//                                                                   //
//        _     _ _     _      __                            _       //
//    ___| |__ (_) | __| |    / _|_ __ __ _ _ __ ___   ___  | |__    //
//   / __| '_ \| | |/ _` |   | |_| '__/ _` | '_ ` _ \ / _ \ | '_ \   //
//  | (__| | | | | | (_| |   |  _| | | (_| | | | | | |  __/_| | | |  //
//   \___|_| |_|_|_|\__,_|___|_| |_|  \__,_|_| |_| |_|\___(_)_| |_|  //
//                      |_____|                                      //
//                                                                   //
//         a window that exists as a tab in a frame window           //
//                                                                   //
//           (part of the 'frame window' support API)                //
//                                                                   //

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

    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 _CHILD_FRAME_H_INCLUDED_
#define _CHILD_FRAME_H_INCLUDED_

#include "text_object.h"
#include "frame_window.h"


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


// SEE frame_window.h for WBChildFrame definition

#define CHILD_FRAME_TAG (*((const unsigned int * const)"FWCF"))

#define CHILD_FRAME_UI_TAG ((WB_UINT32)'F' | ((WB_UINT32)'W' << 8) | ((WB_UINT32)'C' << 16) | ((WB_UINT32)'U' << 24)) /* FWCU */

#define FW_FILE_NEW_MENU          "IDM_FILE_NEW"         
#define FW_FILE_CLOSE_MENU        "IDM_FILE_CLOSE"       
#define FW_FILE_OPEN_MENU         "IDM_FILE_OPEN"        
#define FW_FILE_SAVE_MENU         "IDM_FILE_SAVE"        
#define FW_FILE_SAVE_AS_MENU      "IDM_FILE_SAVE_AS"     
#define FW_FILE_SAVE_ALL_MENU     "IDM_FILE_SAVE_ALL"    
#define FW_EDIT_CUT_MENU          "IDM_EDIT_CUT"         
#define FW_EDIT_COPY_MENU         "IDM_EDIT_COPY"        
#define FW_EDIT_PASTE_MENU        "IDM_EDIT_PASTE"       
#define FW_EDIT_DELETE_MENU       "IDM_EDIT_DELETE"      
#define FW_EDIT_SELECT_ALL_MENU   "IDM_EDIT_SELECT_ALL"  
#define FW_EDIT_SELECT_NONE_MENU  "IDM_EDIT_SELECT_NONE" 
#define FW_EDIT_UNDO_MENU         "IDM_EDIT_UNDO"        
#define FW_EDIT_REDO_MENU         "IDM_EDIT_REDO"        
#define FW_EDIT_PROPERTIES_MENU   "IDM_EDIT_PROPERTIES"  
#define FW_FILE_NEW_ACCEL         "Ctrl+N"               
#define FW_FILE_CLOSE_ACCEL       "Ctrl+F4"              
#define FW_FILE_OPEN_ACCEL        "Ctrl+O"               
#define FW_FILE_SAVE_ACCEL        "Ctrl+S"               
#define FW_FILE_SAVE_AS_ACCEL     "Ctrl+Shift+S"         
#define FW_FILE_SAVE_ALL_ACCEL    "Ctrl+Shift+L"         
#define FW_EDIT_CUT_ACCEL         "Ctrl+X"               
#define FW_EDIT_COPY_ACCEL        "Ctrl+C"               
#define FW_EDIT_PASTE_ACCEL       "Ctrl+V"               
#define FW_EDIT_SELECT_ALL_ACCEL  "Ctrl+A"               
#define FW_EDIT_SELECT_NONE_ACCEL "Ctrl+Shift+A"         
#define FW_EDIT_UNDO_ACCEL        "Ctrl+Z"               
#define FW_EDIT_REDO_ACCEL        "Ctrl+Shift+Z"         
#define FW_EDIT_PROPERTIES_ACCEL  "Alt+Enter"            
int FWInitChildFrame(WBChildFrame *pChildFrame, WBFrameWindow *pOwner, WB_FONTC pFont,
                     const char *szFocusMenu, const WBFWMenuHandler *pHandlerArray,
                     WBWinEvent pUserCallback, int fFlags);

void FWDestroyChildFrame(WBChildFrame *pChildFrame);

void FWSetChildFrameMenu(WBChildFrame *pChildFrame, const char *szFocusMenu);

void FWSetChildFrameContextMenuID(WBChildFrame *pChildFrame, int nID);

void FWSetChildFrameMenuHandlers(WBChildFrame *pChildFrame, const WBFWMenuHandler *pHandlerArray);

void FWSetChildFrameDisplayName(WBChildFrame *pChildFrame, const char *szDisplayName);

void FWSetChildFrameImageAtom(WBChildFrame *pChildFrame, Atom aImage);

void FWSetChildFrameExtent(WBChildFrame *pChildFrame, int iXExtent, int iYExtent);


void FWSetChildFrameScrollInfo(WBChildFrame *pChildFrame, int iRow, int iMaxRow, int iCol, int iMaxCol,
                               int iRowHeight, int iColWidth);


void FWChildFrameRecalcLayout(WBChildFrame *pChildFrame);


void FWChildFrameStatusChanged(WBChildFrame *pChildFrame);

int FWChildFrameQueryClose(WBChildFrame *pChildFrame);


int FWChildFrameEvent(Window wID, XEvent *pEvent);


static __inline__ WBChildFrame *FWGetChildFrameStruct(Window wID)
{
  WBChildFrame *pRval = (WBChildFrame *)WBGetWindowData(wID, 0);  // offset 0 for window-specific structs
  if(pRval && pRval->ulTag == CHILD_FRAME_TAG)
  {
    return(pRval);
  }

  return(NULL);
}



#ifdef __cplusplus
};
#endif // __cplusplus

#endif // _CHILD_FRAME_H_INCLUDED_