mi32/texted.h

Go to the documentation of this file.

/***
** Copyright 1993, 1994 by Markku Savela and
** Technical Research Centre of Finland
 *
 * \if NODOC
 * $Log: texted.h_v $
 * Revision 1.39  2011/11/08 13:35:21  mju
 * Remove redundant hdr and add inclusion guard check.
 *
 * Revision 1.38  2008/09/08 13:24:19  mju
 * Fix doxygen warning.
 *
 * Revision 1.37  2006/10/04 22:15:16  dwilliss
 * Added function to get the EDITMENU
 *
 * Revision 1.36  2005/05/16 14:12:33  dwilliss
 * *** empty log message ***
 *
 * Revision 1.35  2005/03/31 16:57:21  fileserver!dwilliss
 * Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
 *
 * Revision 1.34  2005/03/25 16:07:46  dwilliss
 * new proto
 *
 * Revision 1.33  2004/08/12 21:04:30  dwilliss
 * Added a prototype for new function
 *
 * Revision 1.32  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * \endif
*/

#ifndef INC_MI32_TEXTED_H
#define INC_MI32_TEXTED_H

#ifndef  INC_MI32_TEXT_H
#include <mi32/text.h>
#endif

#ifndef  INC_MI32_ELEMSTYL_H
#include <mi32/elemstyl.h>
#endif


/* Parameters:

 Name         Class     RepType     Default Value
 ----         -----     -------     -------------
 alignment           XeAlignment        XeAlignment     XeStartAligned
 allowEdit           AllowEdit          Boolean         True
 background      Background      Pixel    XtDefaultBackground
 border          BorderColor  Pixel    XtDefaultForeground
 borderWidth        BorderWidth  Dimension   1
 contentFile         ContentFile        String          NULL
 contentLength       ContentLength      int            Computed from content
 contentOffset       ContentOffset      int            0
 contentStream       ContentStream      FILE *          NULL
 contentString       ContentString      Pointer         NULL
 cursor              Cursor             Cursor          None
 cursorPosition      CursorPosition     int            0
 destroyCallback     Callback    Pointer     NULL
 displayCaret        Output             Boolean         True
 exportFormat        ExportFormat       XeTextExport    XeTextExport_ODIF
 firstLineOffset     Offset             int             0
 fonts               XeFonts            XeFont *        NULL
 format              Format             Boolean         False
 graphicRendition    Rendition          String          NULL
 height          Height    Dimension   0
 indentation         Offset             Dimension       0
 initialState        Sequence           String          NULL
 itemization         Itemization        XeItemization * NULL
 kerningOffset       KerningOffset      Dimension *     NULL
 lineLayoutTable     LineLayoutTable    XeTabStop *     NULL
 lineSpacing         LineSpacing        Dimension       Computed from font
 mappedWhenManaged   MappedWhenManaged Boolean     True
 modifyCallback      ModifyCallback     Pointer         NULL
 proportional        Proportional       Boolean         False
 width           Width     Dimension   0
 x         Position     Position 0
 y         Position     Position 0

*/

/* New fields */
#define XtNallowEdit "allowEdit"
#define XtCAllowEdit "AllowEdit"
#define XtNcursorPosition "cursorPosition"
#define XtCCursorPosition "CursorPosition"
#define XtNmodifyCallback "modifyCallback"
#define XtCModifyCallback "ModifyCallback"
#define XtNblinkRate "blinkRate"
#define XtCBlinkRate "BlinkRate"
#define XtNpasswordMode "passwordMode"
#define XtCPasswordMode "PasswordMode"
#ifndef XtNdisplayCaret
#define XtNdisplayCaret "displayCaret"
#endif
#ifndef XtCOutput
#define XtCOutput "Output"
#endif
/* Class record constants */

#if defined(__cplusplus)
extern "C" {
#endif

extern WidgetClass xeTextEdWidgetClass;

#if defined(__cplusplus)
}
#endif

typedef struct _XeTextEdClassRec *XeTextEdWidgetClass;
typedef struct _XeTextEdRec      *XeTextEdWidget;

typedef struct {
   MIUNICODE *ucptr;
   int length;
   } XeTextBlockRec, *XeTextBlock;

struct TEXTSTYLE;

struct XeTextVerifyCallbackStruct {
   int reason;
   XEvent *event;
   Boolean doit;
   int currInsert, newInsert;
   int startPos, endPos;
   XeTextBlock text;
   const TEXTSTYLE* style;
   };

#define XeCR_UP_ARROW   XmCR_INCREMENT
#define XeCR_DOWN_ARROW XmCR_DECREMENT

/*
** XeTextModifyCallbackData
** is the data supplied for the XtNmodifyCallback just before
** the content is prepared for any modifications. The callback
** function has the option of preventing the modification by
** setting the field 'cancel' to True.
*/
typedef struct XeTextModifyCallbackData
    {
   int reason;    
   Boolean cancel;      
    } XeTextModifyCallbackData;

/*
** XeTextUnit
*/
typedef enum
    {
   XeTextUnit_POINT, 
   XeTextUnit_POSITION, 
   XeTextUnit_WORD,  
   XeTextUnit_LINE,  
   XeTextUnit_LINE_BEGIN,  
   XeTextUnit_LINE_END, 
   XeTextUnit_PARAGRAPH,   
   XeTextUnit_TAG,      
   XeTextUnit_ALL    
    } XeTextUnit;


_XFUNCPROTOBEGIN

void XeTextEnableDisplay
   (
#if NeedFunctionPrototypes
   Widget
#endif
   );

void XeTextDisableDisplay
   (
#if NeedFunctionPrototypes
    Widget
#endif
    );

void XeTextDisplay
   (
#if NeedFunctionPrototypes
    Widget
#endif
    );

Boolean XeTextSaveAsFile
   (
#if NeedFunctionPrototypes
    Widget, 
    String     
#endif
    );

void XeTextSetString
   (
    Widget,  
    const char *     /* String to set (in ASCII ISO-2022) */
    );

#define XeTextSetStringUnicode XeTextSetStringUC   

void XeTextSetStringUC
   (
    Widget, 
    const MIUNICODE *   /* Unicode string to set */
    );

String XeTextGetString
   (
    Widget, 
    int *      /* Number of octets returned */
    );

#define XeTextGetStringUnicode XeTextGetStringUC   

MIUNICODE *XeTextGetStringUC
   (
    Widget  
    );


MIUNICODE *XeTextGetSelectionUC (
    Widget  
    );

String XeTextGetSubstring
   (
    Widget, 
    int *,  /* Number of octets returned */
    int,    
    int     
    );

int XeTextGetLength
   (
    Widget, 
    int     
    );

#define XeTextMakeCursorPositionVisible XeTextMakeCursorPositionVisable

void XeTextMakeCursorPositionVisable
   (
    Widget, 
    void *     /* Location or NULL for current insert pos */
    );

int XeTextGetInsertionPosition
   (
    Widget  
    );

void XeTextSetInsertionPosition
   (
    Widget, 
    int     
    );

typedef int (*XeTextExtractFeed)
 (
  MIUNICODE *,    /* Extracted text portion */
  int,         
  XeTextTag,      
  XtPointer    
 );

void XeTextExtract
   (
    Widget, 
    int,    
    int,    
    XeTextExtractFeed, 
    XtPointer  
    );

void XeTextReplace
   (
    Widget, 
    int,    
    int,    
    const char *, /* Pointer to the octest to be inserted */
    int     
    );

void XeTextInsert
   (
#if NeedFunctionPrototypes
    Widget, 
    const char *, /* Pointer to octest to be inserted */
    int     
#endif
    );

void XeTextInsertUnicode
   (
#if NeedFunctionPrototypes
    Widget, 
    const MIUNICODE *   /* Pointer to Unicode string to be inserted */
#endif
    );

void XeTextReplaceTagged
   (
    Widget, 
    int,    
    int,    
    const char *, /* Pointer to octets to be inserted */
    int,    
    XeTextTag  
    );

void XeTextReplaceTaggedUC
   (
    Widget, 
    int,    
    int,    
    const MIUNICODE *,  /* Pointer to octets to be inserted */
    int,    
    XeTextTag  
    );

int XeTextGetInsertionPoint
   (
#if NeedFunctionPrototypes
    Widget     
#endif
    );

int XeTextScan
   (
#if NeedFunctionPrototypes
    Widget, 
    XeTextUnit,   
    int     
#endif
    );

int XeTextSearch
   (
#if NeedFunctionPrototypes
    Widget, 
    int,    
    const char *, /* "Compound" string to search */
    int,    
    int     
#endif
    );

XeTextTag XeTextGetInsertionTag
   (
#if NeedFunctionPrototypes
    Widget     
#endif
    );

void XeTextGetSelectionPosition
   (
#if NeedFunctionPrototypes
    Widget, 
    int *,  /* Virtual offset of the start of selection */
    int *      /* Virtual offset of the end of selection */
#endif
    );

void XeTextSetSelection
   (
#if NeedFunctionPrototypes
    Widget, 
    int,    
    int     
#endif
    );

void XeTextUnsetSelection
   (
#if NeedFunctionPrototypes
    Widget     
#endif
    );

void XeTextCut(Widget);
void XeTextCopy(Widget);
void XeTextPaste(Widget);
void XeTextRemove(Widget); /* like cut but don't change clipboard */

void _XeTextMarkSelection(Widget);
void _XeTextPrepareToScrol(Widget);
void _XeTextUpdateFromScro(Widget);
void _XeAdjustScrollBars(Widget);

bool XeTextScrollToAnchor(Widget, const MIUNICODE* anchor);

void XeTextKeyEventHandler(Widget, XtPointer, XEvent*, Boolean*);

_XFUNCPROTOEND


#if defined(__cplusplus)

inline MISTRING XeTextGetString (
   Widget xetext                       
   ) {
   MIUNICODE *ucstr = XeTextGetStringUC(xetext);
   MISTRING string(ucstr);
   free(ucstr);
   return (string);
   }

inline void XeTextGetString (
   Widget xetext,                      
   MISTRING& string                    
   ) {
   MIUNICODE *ucstr = XeTextGetStringUC(xetext);
   string = ucstr;
   free(ucstr);
   return;
   }

inline void XeTextInsert (
   Widget xetext,                      
   const char* string
   ) {
   XeTextInsert(xetext,string,strlen(string));
   return;
   }

inline void XeTextInsert (
   Widget xetext,                      
   const MIUNICODE* string             
   ) {
   XeTextInsertUnicode(xetext,string);
   return;
   }

class EDITMENU;

EDITMENU* XeTextAddPopupEditMenu (
   Widget xetext
   );

EDITMENU* XeTextGetEditMenu (
   Widget xetext
   );

const TEXTSTYLE& XeTextGetStyle (
   Widget widget,
   int offset  
   );

void XeTextSetStyle (
   Widget widget,
   const TEXTSTYLEDIFF& style,   
   int startoffset = -1,   
   int endoffset = -1   
   );

#ifndef GENERATING_DOXYGEN_OUTPUT
/*
void XeTextSetBaseStyle (
   Widget widget,
   const TEXTSTYLE& style
   );
   */
#endif 

#endif   


#define XeIsXeText(w) XtIsSubclass((w), xeTextEdWidgetClass)


#endif  // INC_MI32_TEXTED_H

---