TextEditorLine.h

Go to the documentation of this file.

#pragma once
 
//
// (C) Copyright 2005-2024 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
class AcGePoint2d;
class AcGePoint3d;
template < typename Param1, typename Param2 > class StrTraitMFC_DLL;
class TextEditor;
class TextEditorBounds;
class TextEditorCharAttributes;
class TextEditorCharCommand;
class TextEditorCharCommandList;
class TextEditorParaNumbering;
struct TextEditorLineNumbering;
struct TextEditorOutputState;
struct TextEditorPointPair;
 
class ARX_API TextEditorLine
{
public:
struct TextEditorLineAdjust
{
};
 
struct TextEditorLineAnalyze
{
};
 
struct TextEditorLineDraw
{
};
 
struct TextEditorLineExtents
{
};
 
struct TextEditorLineNumberingControl
{
};
 
struct TextEditorLineTabRun
{
};
 
struct TextEditorLineTraits
{
};
 
private:
         static double const kAscentFraction;
         static double const kAscentPart;
         static double const kDescentFraction;
         static double const kDescentPart;
         static double const kHeightFactor;
         static double const kInterlineFactor;
         static double const kLineFactor;
         static double const kSumOfParts;
         static double const kTotalFactor;
 
public:
          TextEditorLine( TextEditor *);
          TextEditorLine( TextEditorLine const &);
         bool  adjust_valid(void)const ;
         bool  change_case(bool,int,int);
         bool  end_of_column(void)const ;
         bool  end_of_paragraph(void)const ;
         bool  find_break(int,int &);
         bool  graphics_valid(void)const ;
         bool  in_bounds( TextEditorBounds const &,int,int);
         bool  is_empty(void)const ;
         bool  metrics_valid(void)const ;
         bool  numbering_overflow(void)const ;
         bool  numbering_restart(int)const ;
         bool  start_of_column(void)const ;
         bool  start_of_paragraph(void)const ;
         bool  traits_valid(void)const ;
         bool  write_dtext( CStringA &,int,int, TextEditorOutputState &)const ;
         bool  write_dtext( CStringA &, TextEditorOutputState &)const ;
         bool  write_dtext( CStringW &,int,int, TextEditorOutputState &)const ;
         bool  write_dtext( CStringW &, TextEditorOutputState &)const ;
          CStringW const &  string(void)const ;
          AcGePoint2d const &  extents(void)const ;
          AcGePoint2d const &  offset(void)const ;
          AcGePoint3d  cursor_position(int);
          AcGePoint3d  cursor_position(void);
          AcGePoint3d const &  draw_pos(void)const ;
          TextEditorCharAttributes const &  char_attributes(int)const ;
          TextEditorCharCommand *  active_command(int)const ;
          TextEditorCharCommandList const &  char_command_list(void)const ;
          TextEditorLine &  operator=( TextEditorLine const &);
          TextEditorLine *  clone(int,int)const ;
          TextEditorLine *  next(void)const ;
          TextEditorLine *  prev(void)const ;
         double  GetShdrawXMin(void)const ;
         double  GetShdrawYMax(void)const ;
         double  GetShdrawYMin(void)const ;
         double  align_factor(void)const ;
         double  ascent(void)const ;
         double  baseline_adjustment(void)const ;
         double  container_width(void)const ;
         double  descent(void)const ;
         double  edge_offset(void)const ;
         double  end_indent(void)const ;
         double  global_flow_adjustment( TextEditorCharAttributes const &)const ;
         double  height_scale(void)const ;
         double  local_flow_adjustment(int,double)const ;
         double  size(void)const ;
         double  spacing(double &,double &)const ;
         double  spacing(int)const ;
         double  start_indent(void)const ;
         double  trail(void)const ;
         double  width_scale(void)const ;
         int  container_index(void)const ;
         int  end_status(void)const ;
         int  find_beginning_of_word(int,int);
         int  find_end_of_word(int,int);
         int  index(void)const ;
         int  length(void)const ;
         int  move_index(int,int);
         int  numbering_value(int)const ;
         int  para_attributes_index(void)const ;
         int  start_status(void)const ;
          TextEditorLineNumbering const *  numbering(void)const ;
          TextEditorLinePick  pick_char( AcGePoint3d const &,int);
         virtual  ~TextEditorLine(void);
         virtual void  erase(void);
         void  adjust_dtext(void);
         void  adjust_mtext(void);
         void  align_dtext(void);
         void  append( TextEditorLine *);
         void  calc_numbering_indents(double &,double &);
         void  chop(void);
         void  convert_white_space(int,bool, TextEditorLine *);
         void  delete_character(int);
         void  delete_characters(int,int);
         void  delete_numbering_string(void);
         void  draw_dtext(void);
         void  draw_mtext(void);
         void  fit_dtext(void);
         void  flush_char_attributes( TextEditorCharAttributes const &,int,int);
         void  generate_numbering_string( TextEditorParaNumbering const &);
         void  get_characters( CStringW &,int,int)const ;
         void  get_commands( TextEditorCharCommandList &,int,int)const ;
         void  insert_character(int,wchar_t, TextEditorCharAttributes const &);
         void  insert_character(wchar_t);
         void  insert_character(wchar_t, TextEditorCharAttributes const &);
         void  insert_string( CStringW const &);
         void  merge( TextEditorLine *,bool);
         void  move_index(int);
         void  remove_character(void);
         void  scale_text_height(double);
         void  set_adjust_valid(bool);
         void  set_char_attributes( TextEditorCharAttributes const &,int,int);
         void  set_character(int,wchar_t);
         void  set_container_index(int);
         void  set_container_width(double);
         void  set_draw_pos( AcGePoint3d const &);
         void  set_end_status(int);
         void  set_graphics_valid(bool);
         void  set_index(int);
         void  set_metrics_valid(bool);
         void  set_next( TextEditorLine *);
         void  set_numbering_restart(int,bool);
         void  set_numbering_value(int,int);
         void  set_offset( AcGePoint2d const &);
         void  set_para_attributes_index(int);
         void  set_prev( TextEditorLine *);
         void  set_size(double);
         void  set_start_status(int);
         void  set_traits_valid(bool);
         void  split( TextEditorLine *);
         void  toggle_control(int,bool);
         void  write_mtext( CStringA &,int,int, TextEditorOutputState &);
         void  write_mtext( CStringA &, TextEditorOutputState &);
         void  write_mtext( CStringW &,int,int, TextEditorOutputState &);
         void  write_mtext( CStringW &, TextEditorOutputState &);
         void  write_unicode_text( CStringW &);
         wchar_t  auto_character(int)const ;
         wchar_t  character(int)const ;
         wchar_t  next_char(int)const ;
         wchar_t  prev_char(int)const ;
 
protected:
         bool  is_word_stop(int,int)const ;
          TextEditor *  editor(void)const ;
         static bool __cdecl is_justifiable_char(wchar_t);
          TextEditorLineTraits const *  traits(void);
         virtual  TextEditorLineNumberingControl *  numbering_control(void);
         virtual  TextEditorLineNumberingControl const *  numbering_control(void)const ;
         virtual void  post_adjust(void);
         virtual void  post_draw(void);
         virtual void  pre_adjust(void);
         virtual void  pre_draw(void);
         virtual void  render_text(wchar_t const *,int, AcGePoint3d const &, TextEditorCharAttributes const &);
         virtual void  render_text_highlight( TextEditorPointPair const &, TextEditorCharAttributes const &);
         virtual void  render_text_highlight( TextEditorPointPair const &, TextEditorVectorPair const &, TextEditorCharAttributes const &);
         virtual void  render_text_line( TextEditorPointPair const &);
         virtual void  set_numbering_control( TextEditorLineNumberingControl const *);
         void  calc_extents(int,int,bool, TextEditorLineExtents &);
 
private:
         bool  breaking_field(void);
         bool  change_case(bool, TextEditorCharAttributes const &,int,int);
         bool  overflows( TextEditorLineAdjust &)const ;
          AcGePoint3d const &  char_position(int)const ;
         double  break_width(void)const ;
         double  char_extent(int)const ;
         double  leading_space(wchar_t const *,int, TextEditorCharAttributes const &,bool &)const ;
         double  numbering_size(int);
         double  numbering_size(void);
         double  stack_extent( TextEditorCharAttributes const &, TextEditorLineAdjust &);
         double  stack_trail( TextEditorCharAttributes const &)const ;
         int  convert_to_spaces( TextEditorCharAttributes const &,double,bool,bool);
         int  find_break_index( TextEditorLineTraits const *,int,int,int &)const ;
         int  sub_extent(int,int, TextEditorLineAdjust &);
         static void __cdecl mtext_convert_func( TextEditorLine *,int,int, TextEditorCharAttributes const &, TextEditorLineDraw &);
         static void __cdecl mtext_draw_func( TextEditorLine *,int,int, TextEditorCharAttributes const &, TextEditorLineDraw &);
         static void __cdecl mtext_metrics_func( TextEditorLine *,int,int, TextEditorCharAttributes const &, TextEditorLineDraw &);
         void  accumulate_extent(double,wchar_t const *,int, TextEditorCharAttributes const &, TextEditorLineAdjust &);
         void  adjust_heights(double,double,double);
         void  analyze_text(int,int, TextEditorLineAnalyze &);
         void  calc_bigfont_escapes( TextEditorLineTraits *);
         void  calc_breaks( TextEditorLineTraits *);
         void  calc_dtext_metrics(void);
         void  calc_metrics(void);
         void  calc_mtext_metrics(void);
         void  calc_runs(bool);
         void  calc_traits(void);
         void  cleanup_commands(void);
         void  distribute_mtext( TextEditorLineAdjust const &);
         void  dtext_adjust(int,int, TextEditorCharAttributes const &);
         void  dtext_draw(int,int, TextEditorCharAttributes const &, TextEditorLineDraw &);
         void  dtext_metrics(int,int, TextEditorCharAttributes const &, TextEditorLineDraw &);
         void  end_metrics(int, TextEditorLineDraw &);
         void  find_tab_stop(double, TextEditorLineTabRun &)const ;
         void  finish_tabrun( TextEditorLineAdjust &);
         void  justify_mtext( TextEditorLineAdjust const &);
         void  mtext_adjust(int,int, TextEditorCharAttributes const &, TextEditorLineAdjust &);
         void  mtext_adjust(wchar_t const *,int, TextEditorCharAttributes const &, TextEditorLineAdjust &);
         void  mtext_convert(int,int, TextEditorCharAttributes const &, TextEditorLineDraw &);
         void  mtext_draw(int,int, TextEditorCharAttributes const &, TextEditorLineDraw &);
         void  mtext_draw(wchar_t const *,int, TextEditorCharAttributes const &, TextEditorLineDraw &);
         void  mtext_extent(int,int, TextEditorCharAttributes const &, TextEditorLineAdjust &);
         void  mtext_extent(wchar_t const *,int, TextEditorCharAttributes const &, TextEditorLineAdjust &);
         void  mtext_metrics(int,int, TextEditorCharAttributes const &, TextEditorLineDraw &);
         void  numbering_adjust( TextEditorLineAdjust &);
         void  numbering_draw( TextEditorLineDraw &);
         void  numbering_extent( TextEditorLineAdjust &);
         void  numbering_metrics( TextEditorLineDraw &);
         void  run_mtext_func( TextEditorLineDraw &,void (__cdecl*)( TextEditorLine *,int,int, TextEditorCharAttributes const &, TextEditorLineDraw &));
         void  set_char_attributes_forreal( TextEditorCharAttributes const &,int,int,bool);
         void  set_char_metrics(int, AcGePoint3d const &,double);
         void  stack_adjust( TextEditorCharAttributes const &, TextEditorLineAdjust &);
         void  stack_convert( TextEditorCharAttributes const &, TextEditorLineDraw &);
         void  stack_draw( TextEditorCharAttributes const &, TextEditorLineDraw &);
         void  tab_adjust( TextEditorCharAttributes const &, TextEditorLineAdjust &);
         void  tab_convert( TextEditorCharAttributes const &, TextEditorLineDraw &);
         void  tab_draw( TextEditorCharAttributes const &, TextEditorLineDraw &);
         void  tab_extent( TextEditorCharAttributes const &, TextEditorLineAdjust &);
         void  terminate_paragraph(void);
         void  text_metrics(int,int, TextEditorCharAttributes const &, TextEditorLineDraw &);
         wchar_t const *  convert_characters(int,int, CStringW &)const ;
         wchar_t const *  convert_characters(wchar_t const *,int, CStringW &)const ;
 
};