include/Xm/Text.h

0001 /*
0002  * Motif
0003  *
0004  * Copyright (c) 1987-2012, The Open Group. All rights reserved.
0005  *
0006  * These libraries and programs are free software; you can
0007  * redistribute them and/or modify them under the terms of the GNU
0008  * Lesser General Public License as published by the Free Software
0009  * Foundation; either version 2 of the License, or (at your option)
0010  * any later version.
0011  *
0012  * These libraries and programs are distributed in the hope that
0013  * they will be useful, but WITHOUT ANY WARRANTY; without even the
0014  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
0015  * PURPOSE. See the GNU Lesser General Public License for more
0016  * details.
0017  *
0018  * You should have received a copy of the GNU Lesser General Public
0019  * License along with these librararies and programs; if not, write
0020  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
0021  * Floor, Boston, MA 02110-1301 USA
0022 */
0023 #ifndef _XmText_h
0024 #define _XmText_h
0025
0026 #include <Xm/Xm.h>
0027 #include <stdio.h>
0028
0029 #ifdef __cplusplus
0030 extern "C" {
0031 #endif
0032
0033 /* -------------- *
0034  *   type defines *
0035  * -------------- */
0036 typedef struct _XmTextSourceRec *XmTextSource;
0037 typedef struct _XmTextClassRec *XmTextWidgetClass;
0038 typedef struct _XmTextRec *XmTextWidget;
0039
0040 /* -------------- *
0041  * extern class   *
0042  * -------------- */
0043 externalref WidgetClass       xmTextWidgetClass;
0044
0045
0046 /* --------------------------------------- *
0047  *  text widget fast subclassing fallback  *
0048  * --------------------------------------- */
0049
0050 #ifndef XmIsText
0051 #define XmIsText(w) XtIsSubclass(w, xmTextWidgetClass)
0052 #endif /* XmIsText */
0053
0054
0055 /* ----------------------------------- *
0056  *   text widget public functions      *
0057  * ----------------------------------- */
0058
0059 /********    Public Function Declarations    ********/
0060
0061 extern void XmTextSetHighlight(
0062                         Widget w,
0063                         XmTextPosition left,
0064                         XmTextPosition right,
0065                         XmHighlightMode mode);
0066 extern Widget XmCreateScrolledText(
0067                         Widget parent,
0068                         char *name,
0069                         ArgList arglist,
0070                         Cardinal argcount);
0071 extern Widget XmCreateText(
0072                         Widget parent,
0073                         char *name,
0074                         ArgList arglist,
0075                         Cardinal argcount);
0076 extern Widget XmVaCreateText(
0077                         Widget parent,
0078                         char *name,
0079                         ...);
0080 extern Widget XmVaCreateManagedText(
0081                         Widget parent,
0082                         char *name,
0083                         ...);
0084 extern int XmTextGetSubstring(
0085                         Widget widget,
0086                         XmTextPosition start,
0087                         int num_chars,
0088                         int buf_size,
0089                         char *buffer);
0090 extern int XmTextGetSubstringWcs(
0091                         Widget widget,
0092                         XmTextPosition start,
0093                         int num_chars,
0094                         int buf_size,
0095                         wchar_t *buffer);
0096 extern char * XmTextGetString(
0097                         Widget widget);
0098 extern wchar_t * XmTextGetStringWcs(
0099                         Widget widget);
0100 extern XmTextPosition XmTextGetLastPosition(
0101                         Widget widget);
0102 extern void XmTextSetString(
0103                         Widget widget,
0104                         char *value);
0105 extern void XmTextSetStringWcs(
0106                         Widget widget,
0107                         wchar_t *wc_value);
0108 extern void XmTextReplace(
0109                         Widget widget,
0110                         XmTextPosition frompos,
0111                         XmTextPosition topos,
0112                         char *value);
0113 extern void XmTextReplaceWcs(
0114                         Widget widget,
0115                         XmTextPosition frompos,
0116                         XmTextPosition topos,
0117                         wchar_t *value);
0118 extern void XmTextInsert(
0119                         Widget widget,
0120                         XmTextPosition position,
0121                         char *value);
0122 extern void XmTextInsertWcs(
0123                         Widget widget,
0124                         XmTextPosition position,
0125                         wchar_t *wc_value);
0126 extern void XmTextSetAddMode(
0127                         Widget widget,
0128 #if NeedWidePrototypes
0129                         int state);
0130 #else
0131                         Boolean state);
0132 #endif /* NeedWidePrototypes */
0133 extern Boolean XmTextGetAddMode(
0134                         Widget widget);
0135 extern Boolean XmTextGetEditable(
0136                         Widget widget);
0137 extern void XmTextSetEditable(
0138                         Widget widget,
0139 #if NeedWidePrototypes
0140                         int editable);
0141 #else
0142                         Boolean editable);
0143 #endif /* NeedWidePrototypes */
0144 extern int XmTextGetMaxLength(
0145                         Widget widget);
0146 extern void XmTextSetMaxLength(
0147                         Widget widget,
0148                         int max_length);
0149 extern XmTextPosition XmTextGetTopCharacter(
0150                         Widget widget);
0151 extern void XmTextSetTopCharacter(
0152                         Widget widget,
0153                         XmTextPosition top_character);
0154 extern XmTextPosition XmTextGetCursorPosition(
0155                         Widget widget);
0156 extern XmTextPosition XmTextGetInsertionPosition(
0157                         Widget widget);
0158 extern void XmTextSetInsertionPosition(
0159                         Widget widget,
0160                         XmTextPosition position);
0161 extern void XmTextSetCursorPosition(
0162                         Widget widget,
0163                         XmTextPosition position);
0164 extern Boolean XmTextRemove(
0165                         Widget widget);
0166 extern Boolean XmTextCopy(
0167                         Widget widget,
0168                         Time copy_time);
0169 extern Boolean XmTextCopyLink(
0170                         Widget widget,
0171                         Time copy_time);
0172 extern Boolean XmTextCut(
0173                         Widget widget,
0174                         Time cut_time);
0175 extern Boolean XmTextPaste(
0176                         Widget widget);
0177 extern Boolean XmTextPasteLink(
0178                         Widget widget);
0179 extern char * XmTextGetSelection(
0180                         Widget widget);
0181 extern wchar_t * XmTextGetSelectionWcs(
0182                         Widget widget);
0183 extern void XmTextSetSelection(
0184                         Widget widget,
0185                         XmTextPosition first,
0186                         XmTextPosition last,
0187                         Time set_time);
0188 extern void XmTextClearSelection(
0189                         Widget widget,
0190                         Time clear_time);
0191 extern Boolean XmTextGetSelectionPosition(
0192                         Widget widget,
0193                         XmTextPosition *left,
0194                         XmTextPosition *right);
0195 extern XmTextPosition XmTextXYToPos(
0196                         Widget widget,
0197 #if NeedWidePrototypes
0198                         int x,
0199                         int y);
0200 #else
0201                         Position x,
0202                         Position y);
0203 #endif /* NeedWidePrototypes */
0204 extern Boolean XmTextPosToXY(
0205                         Widget widget,
0206                         XmTextPosition position,
0207                         Position *x,
0208                         Position *y);
0209 extern XmTextSource XmTextGetSource(
0210                         Widget widget);
0211 extern void XmTextSetSource(
0212                         Widget widget,
0213                         XmTextSource source,
0214                         XmTextPosition top_character,
0215                         XmTextPosition cursor_position);
0216 extern void XmTextShowPosition(
0217                         Widget widget,
0218                         XmTextPosition position);
0219 extern void XmTextScroll(
0220                         Widget widget,
0221                         int n);
0222 extern int XmTextGetBaseline(
0223                         Widget widget);
0224 extern int XmTextGetCenterline(
0225                         Widget widget);
0226 extern void XmTextDisableRedisplay(
0227                         Widget widget);
0228 extern void XmTextEnableRedisplay(
0229                         Widget widget);
0230 extern Boolean XmTextFindString(
0231                         Widget w,
0232                         XmTextPosition start,
0233                         char *search_string,
0234                         XmTextDirection direction,
0235                         XmTextPosition *position);
0236 extern Boolean XmTextFindStringWcs(
0237                         Widget w,
0238                         XmTextPosition start,
0239                         wchar_t *wc_string,
0240                         XmTextDirection direction,
0241                         XmTextPosition *position);
0242
0243 /********    End Public Function Declarations    ********/
0244
0245 /* tmp: go to XmStrDefs */
0246 #define XmNtotalLines "totalLines"
0247 #define XmCTotalLines "TotalLines"
0248
0249 #ifdef __cplusplus
0250 }  /* Close scope of 'extern "C"' declaration which encloses file. */
0251 #endif
0252
0253 #endif /* _XmText_h */
0254 /* DON'T ADD STUFF AFTER THIS #endif */