Blender V5.3
blender::ui::MarkdownLayouter Class Reference

Classes

struct  ContextFontSettings

Public Member Functions

 MarkdownLayouter (MarkdownLayoutCache &cache_)
FontConfig make_font_config (const int fontid, const float default_size, const int default_weight, const int bold_weight)
void compute_layout ()
void add_pending_spacing (const float spacing)
void line_box_end ()
void add_line_break ()
void md_enter_block (const MD_BLOCKTYPE block_type, void *detail)
float list_indent_px () const
float code_block_padding_x_px () const
float code_block_padding_y_px () const
float code_span_padding_x_px () const
float code_span_padding_y_px () const
CodeSpan * mutable_current_code_span ()
float context_block_start_x () const
float context_content_start_x () const
float context_content_end_x () const
void append_pending_list_marker ()
void append_horizontal_rule ()
void track_quote_text_bounds (const MarkdownItemText &item)
void track_code_text_bounds (const MarkdownItemText &item)
void apply_code_span_left_padding ()
void finalize_code_span_line_bounds ()
void append_code_span_boxes (const CodeSpan &code_span)
void extend_flow_bottom_for_code_block (const CodeBlock &code_block)
void append_code_block_box ()
void append_quote_line ()
bool is_in_quote () const
bool is_in_fenced_code_block () const
bool has_code_span () const
bool is_code () const
bool is_direct_child_of_list_item () const
float spacing_px (const float multiplier) const
float block_margin_top (const MdBlock &block) const
float block_margin_bottom (const MdBlock &block) const
void md_leave_block (const MD_BLOCKTYPE block_type, void *)
void md_enter_span (const MD_SPANTYPE span_type, void *detail)
void md_leave_span (const MD_SPANTYPE span_type, void *)
void md_text (const MD_TEXTTYPE text_type, const StringRef text)
void md_text_normal (const StringRef text)
void md_text_code (StringRef text)
void ensure_line_box (const int fontid)
ContextFontSettings get_context_font_settings () const
void output_wrapped_text (StringRef text, const float size, const int fontid, const int weight, const bool italic, const std::optional< StringRef > &url, const float start_x)
void finalize_vertical_positions ()

Static Public Member Functions

static StringRef unordered_bullet_for_level (const int level)
static bool is_list_container_block (const MdBlock &block)

Detailed Description

Utility class used to take raw markdown as input and turn it into positions for text and other elements. A class is used to simplify state management during the parsing process.

Definition at line 156 of file interface_label_markdown.cc.

Constructor & Destructor Documentation

◆ MarkdownLayouter()

blender::ui::MarkdownLayouter::MarkdownLayouter ( MarkdownLayoutCache & cache_)
inline

Member Function Documentation

◆ add_line_break()

void blender::ui::MarkdownLayouter::add_line_break ( )
inline

Definition at line 334 of file interface_label_markdown.cc.

References line_box_end().

Referenced by md_text(), and md_text_code().

◆ add_pending_spacing()

void blender::ui::MarkdownLayouter::add_pending_spacing ( const float spacing)
inline

Definition at line 320 of file interface_label_markdown.cc.

References spacing_px().

Referenced by md_enter_block(), and md_leave_block().

◆ append_code_block_box()

◆ append_code_span_boxes()

◆ append_horizontal_rule()

void blender::ui::MarkdownLayouter::append_horizontal_rule ( )
inline

◆ append_pending_list_marker()

◆ append_quote_line()

◆ apply_code_span_left_padding()

void blender::ui::MarkdownLayouter::apply_code_span_left_padding ( )
inline

◆ block_margin_bottom()

float blender::ui::MarkdownLayouter::block_margin_bottom ( const MdBlock & block) const
inline

◆ block_margin_top()

float blender::ui::MarkdownLayouter::block_margin_top ( const MdBlock & block) const
inline

◆ code_block_padding_x_px()

float blender::ui::MarkdownLayouter::code_block_padding_x_px ( ) const
inline

◆ code_block_padding_y_px()

float blender::ui::MarkdownLayouter::code_block_padding_y_px ( ) const
inline

◆ code_span_padding_x_px()

float blender::ui::MarkdownLayouter::code_span_padding_x_px ( ) const
inline

◆ code_span_padding_y_px()

float blender::ui::MarkdownLayouter::code_span_padding_y_px ( ) const
inline

◆ compute_layout()

◆ context_block_start_x()

float blender::ui::MarkdownLayouter::context_block_start_x ( ) const
inline

◆ context_content_end_x()

float blender::ui::MarkdownLayouter::context_content_end_x ( ) const
inline

◆ context_content_start_x()

float blender::ui::MarkdownLayouter::context_content_start_x ( ) const
inline

◆ ensure_line_box()

void blender::ui::MarkdownLayouter::ensure_line_box ( const int fontid)
inline

◆ extend_flow_bottom_for_code_block()

void blender::ui::MarkdownLayouter::extend_flow_bottom_for_code_block ( const CodeBlock & code_block)
inline

Definition at line 690 of file interface_label_markdown.cc.

References blender::BLI_rctf_is_empty(), and code_block_padding_y_px().

Referenced by md_leave_block().

◆ finalize_code_span_line_bounds()

void blender::ui::MarkdownLayouter::finalize_code_span_line_bounds ( )
inline

◆ finalize_vertical_positions()

void blender::ui::MarkdownLayouter::finalize_vertical_positions ( )
inline

Definition at line 1240 of file interface_label_markdown.cc.

References line_box_end().

Referenced by compute_layout().

◆ get_context_font_settings()

◆ has_code_span()

bool blender::ui::MarkdownLayouter::has_code_span ( ) const
inline

Definition at line 773 of file interface_label_markdown.cc.

Referenced by ensure_line_box(), is_code(), and output_wrapped_text().

◆ is_code()

bool blender::ui::MarkdownLayouter::is_code ( ) const
inline

Definition at line 783 of file interface_label_markdown.cc.

References has_code_span(), and is_in_fenced_code_block().

◆ is_direct_child_of_list_item()

bool blender::ui::MarkdownLayouter::is_direct_child_of_list_item ( ) const
inline

Definition at line 794 of file interface_label_markdown.cc.

◆ is_in_fenced_code_block()

bool blender::ui::MarkdownLayouter::is_in_fenced_code_block ( ) const
inline

◆ is_in_quote()

bool blender::ui::MarkdownLayouter::is_in_quote ( ) const
inline

◆ is_list_container_block()

bool blender::ui::MarkdownLayouter::is_list_container_block ( const MdBlock & block)
inlinestatic

Definition at line 788 of file interface_label_markdown.cc.

Referenced by md_enter_block().

◆ line_box_end()

void blender::ui::MarkdownLayouter::line_box_end ( )
inline

◆ list_indent_px()

float blender::ui::MarkdownLayouter::list_indent_px ( ) const
inline

◆ make_font_config()

FontConfig blender::ui::MarkdownLayouter::make_font_config ( const int fontid,
const float default_size,
const int default_weight,
const int bold_weight )
inline

◆ md_enter_block()

void blender::ui::MarkdownLayouter::md_enter_block ( const MD_BLOCKTYPE block_type,
void * detail )
inline

◆ md_enter_span()

void blender::ui::MarkdownLayouter::md_enter_span ( const MD_SPANTYPE span_type,
void * detail )
inline

◆ md_leave_block()

void blender::ui::MarkdownLayouter::md_leave_block ( const MD_BLOCKTYPE block_type,
void *  )
inline

◆ md_leave_span()

void blender::ui::MarkdownLayouter::md_leave_span ( const MD_SPANTYPE span_type,
void *  )
inline

◆ md_text()

void blender::ui::MarkdownLayouter::md_text ( const MD_TEXTTYPE text_type,
const StringRef text )
inline

◆ md_text_code()

◆ md_text_normal()

◆ mutable_current_code_span()

CodeSpan * blender::ui::MarkdownLayouter::mutable_current_code_span ( )
inline

◆ output_wrapped_text()

void blender::ui::MarkdownLayouter::output_wrapped_text ( StringRef text,
const float size,
const int fontid,
const int weight,
const bool italic,
const std::optional< StringRef > & url,
const float start_x )
inline

◆ spacing_px()

float blender::ui::MarkdownLayouter::spacing_px ( const float multiplier) const
inline

Definition at line 802 of file interface_label_markdown.cc.

Referenced by add_pending_spacing(), and append_horizontal_rule().

◆ track_code_text_bounds()

◆ track_quote_text_bounds()

◆ unordered_bullet_for_level()

StringRef blender::ui::MarkdownLayouter::unordered_bullet_for_level ( const int level)
inlinestatic

Definition at line 523 of file interface_label_markdown.cc.

Referenced by append_pending_list_marker().


The documentation for this class was generated from the following file: