X11 Work Bench Toolkit  1.0
edit_window.h File Reference

Edit Window API functions. More...

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

Go to the source code of this file.

Data Structures

struct  __WBEditWindow__
 Structure that defines an Edit Window. More...
 

Macros

#define EDIT_WINDOW_TAG   (*((const unsigned int * const)"FWEW"))
 TAG for the WBEditWindow structure.
 

Typedefs

typedef struct __WBEditWindow__ WBEditWindow
 Structure that defines an Edit Window. More...
 

Functions

WBEditWindowWBCreateEditWindow (WBFrameWindow *pOwner, XFontStruct *pFont, const char *szFocusMenu, const WBFWMenuHandler *pHandlerArray, int fFlags)
 Create an Edit Window. More...
 
void WBDestroyEditWindow (WBEditWindow *pEditWindow)
 Destroy an Edit Window. More...
 
WBEditWindowWBEditWindowFromWindowID (Window wID)
 Obtain the associated WBEditWindow structure pointer for a Window ID. More...
 
int WBEditWindowLoadFile (WBEditWindow *pEditWindow, const char *pszFileName)
 Open an existing file and read its contents into the Edit Window, storing the file name for later reference. More...
 
int WBEditWindowSaveFile (WBEditWindow *pEditWindow, const char *pszFileName)
 Save the contents from the Edit Window to a file, overwriting the file if it already exists. More...
 
void WBEditWindowClear (WBEditWindow *pEditWindow)
 Clear the contents in the Edit Window, and NULL the stored file name. More...
 
static __inline int WBIsValidEditWindow (WBEditWindow *pEditWindow)
 Check for valid WBEditWindow pointer. More...
 
void WBEditWindowRegisterCallback (WBEditWindow *pEditWindow, WBWinEvent pUserCallback)
 Clear the contents in the Edit Window, and NULL the stored file name. More...
 

Variables

Atom aEW_HOVER_NOTIFY
 Hover notification to user-callback, sent via ClientMessage event. More...
 
Atom aEW_EDIT_CHANGE
 'Edit Change' notification to user-callback, sent via ClientMessage event More...
 

Detailed Description

Edit Window API functions.

Edit Windows are child windows in which the contained text may be edited, optionally supporting multiple tabs. 'View Only' windows cannot be edited, but support all of the other features of an edit window.
Each edited text object uses the TEXT_OBJECT structure to manage the data and the user interface. The currently active text object will receive all of the appropriate events. The Edit Window also provides for horizontal and vertical scrolling, as needed.

Definition in file edit_window.h.