draw_text.h

Go to the documentation of this file.

//                 _                          _               _       _                 //
//              __| | _ __  __ _ __      __  | |_  ___ __  __| |_    | |__              //
//             / _` || '__|/ _` |\ \ /\ / /  | __|/ _ \\ \/ /| __|   | '_ \             //
//            | (_| || |  | (_| | \ V  V /   | |_|  __/ >  < | |_  _ | | | |            //
//             \__,_||_|   \__,_|  \_/\_/_____\__|\___|/_/\_\ \__|(_)|_| |_|            //
//                                      |_____|                                         //
//                                                                                      //
//                        text draw, multi-line and tabbed text                         //
//                       Also, additional text-related utilities                        //
//                                                                                      //

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

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

#ifndef WINDOW_HELPER_H_INCLUDED
#include "window_helper.h"
#endif // WINDOW_HELPER_H_INCLUDED

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


enum DTAlignment
{
    DTAlignment_HLEFT = 1,               
    DTAlignment_HCENTER = 2,             
    DTAlignment_HRIGHT = 3,              
    DTAlignment_HJUSTIFY = 4,            
    DTAlignment_HMASK = 0xf,             

    DTAlignment_VTOP = 0x10,             
    DTAlignment_VBOTTOM = 0x20,          
    DTAlignment_VCENTER = 0x30,          
    DTAlignment_VCENTERASCENT = 0x40,    
    DTAlignment_VCENTERBASELINE = 0x50,  
    DTAlignment_VTOPHALF = 0x60,         
    DTAlignment_VTBOTTOMHALF = 0x70,     
    DTAlignment_VMASK = 0xf0,

    // these next flags are primarily for DTCalcIdealBounds, and some for DTCalcIdealFont

    DTAlignment_V_BEFORE_H = 0x100,      
    DTAlignment_NO_VRESIZE = 0x200,      
    DTAlignment_NO_HRESIZE = 0x400,      
    DTAlignment_NO_RESIZE  = 0x600,      

    DTAlignment_RESIZE_PIXEL = 0x800,    
    DTAlignment_NO_SHRINK = 0x1000,      

    DTAlignment_ALLOW_TRAILING = 0x2000, 
    DTAlignment_NO_WORD_WRAP = 0x4000,   

    DTAlignment_ANTIALIAS = 0x10000000,  
    DTAlignment_SINGLELINE = 0x20000000, 
    DTAlignment_UNDERSCORE = 0x40000000, 
    DTAlignment_PRINTING = 0x80000000    
};


typedef struct tagDT_WORD
{
  const char *pText;      
  int nLength;            
  int iWidth;             
  int iHeight;            
  int iIsTab;             
  int iIsLineFeed;        
  int iIsWhiteSpace;      
  int iX;                 
  int iY;                 
} DT_WORD;


typedef struct tagDT_WORDS
{
  struct tagDT_WORDS *pPrev; 
  struct tagDT_WORDS *pNext; 
  int nCount;                
  int nMax;                  
  int iMaxWidth;             
  int iMaxHeight;            
  const char *szText;        
  DT_WORD aWords[1];         
} DT_WORDS;



void DTDrawString(Display *pDisplay, Drawable drawable, WB_FONTC pFont,
                  WBGC gc, int x, int y, const char *pString, int nLength);


//  * \brief Calculate the ideal font based on the text and rectangle
//  *
//  * \param pRefFont A pointer to an XFontStruct (NULL implies system default font)
//  * \param szText A pointer to a (0-byte terminated) ASCII string that may span multiple lines
//  * \param geomBounds A pointer to a \ref WB_GEOM structure that defines a bounding rectangle
//  *
//  * sometimes you want to adjust text size to fit within a particular rectangle.  This function
//  * determines how to do that by adjusting the font size.
//  *
//  * Header File:  draw_text.h
//**/
//XFontStruct *DTCalcIdealFont(XFontStruct *pRefFont, const char *szText, WB_GEOM *geomBounds);


WB_FONT DTCalcIdealFont(Display *pDisplay, WB_FONTC pFont, const char *szText, WB_GEOM *geomBounds);


int DTCalcIdealBounds0(XFontStruct *pFont, const char *szText, int iTabWidth, unsigned int iTabOrigin,
                       const WB_RECT *prcSource, WB_RECT *prcDest, int iAlignment);

int DTCalcIdealBounds(Display *pDisplay, WB_FONTC pFont, const char *szText, int iTabWidth, unsigned int iTabOrigin,
                      const WB_RECT *prcSource, WB_RECT *prcDest, int iAlignment);

void DTDrawSingleLineText(WB_FONTC pFontt, const char *szText, Display *pDisplay, WBGC gc, Drawable dw,
                          int iTabWidth, int iTabOrigin, const WB_RECT *prcBounds, int iAlignment);

void DTDrawMultiLineText(WB_FONTC pFont, const char *szText, Display *pDisplay, WBGC gc, Drawable dw,
                         int iTabWidth, int iTabOrigin, const WB_RECT *prcBounds, int iAlignment);


DT_WORDS * DTGetWordsFromText(Display *pDisplay, WB_FONTC pFont, const char *szText, int iAlignment);

void DTPreRender(Display *pDisplay, WB_FONTC pFont, DT_WORDS *pWords, int iTabWidth, int iTabOrigin,
                 WB_RECT *prcBounds, int iAlignment, int iStartLine, int iEndLine);

void DTRender(Display *pDisplay, WB_FONTC pFont, const DT_WORDS *pWords, WBGC gc, Drawable dw,
              int iHScrollBy, int iVScrollBy, const WB_RECT *prcBounds, const WB_RECT *prcViewport, int iAlignment);

#ifdef __cplusplus
};
#endif // __cplusplus


#endif // _DRAW_TEXT_H_INCLUDED_