.. index:: pair: class; EE::UI::Doc::DocumentView
.. _doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view:

class EE::UI::Doc::DocumentView
===============================

.. toctree::
	:hidden:

	struct_EE_UI_Doc_DocumentView_Config.rst
	struct_EE_UI_Doc_DocumentView_LineWrapInfo.rst
	struct_EE_UI_Doc_DocumentView_VisibleLineInfo.rst
	struct_EE_UI_Doc_DocumentView_VisibleLineRange.rst




.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <documentview.hpp>
	
	class DocumentView {
	public:
		// structs
	
		struct :ref:`Config<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_document_view_1_1_config>`;
		struct :ref:`LineWrapInfo<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_document_view_1_1_line_wrap_info>`;
		struct :ref:`VisibleLineInfo<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_document_view_1_1_visible_line_info>`;
		struct :ref:`VisibleLineRange<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_document_view_1_1_visible_line_range>`;

		// construction
	
		:target:`DocumentView<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a4f2d90d25301e2b7dde1b8dbb9739ef8>`(std::shared_ptr<:ref:`TextDocument<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_document>`> doc, :ref:`FontStyleConfig<doxid-class_e_e_1_1_graphics_1_1_font_style_config>` fontStyle, :ref:`Config<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_document_view_1_1_config>` config);

		// methods
	
		static :ref:`LineWrapMode<doxid-namespace_e_e_1_1_u_i_1_1_doc_1a7d921083e01c5ebe7dec06364c9624f2>` :target:`toLineWrapMode<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a337be2b798a58a18eda1a07123d6a5e7>`(std::string mode);
		static std::string :target:`fromLineWrapMode<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a84d07300ef9d18481541440dc058d45a>`(:ref:`LineWrapMode<doxid-namespace_e_e_1_1_u_i_1_1_doc_1a7d921083e01c5ebe7dec06364c9624f2>` mode);
		static :ref:`LineWrapType<doxid-namespace_e_e_1_1_u_i_1_1_doc_1a170d56e1c5ed9ad426480045b8e0ebc7>` :target:`toLineWrapType<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1ab2d3ce928612914a48c6d2f8b0887cdf>`(std::string type);
		static std::string :target:`fromLineWrapType<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a3bf9c511b3ee5b9fff2ef63f852475af>`(:ref:`LineWrapType<doxid-namespace_e_e_1_1_u_i_1_1_doc_1a170d56e1c5ed9ad426480045b8e0ebc7>` type);
	
		static :ref:`LineWrapInfo<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_document_view_1_1_line_wrap_info>` :target:`computeLineBreaks<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a6d971a39108b1596eb0c2d59a892b269>`(
			const :ref:`String::View<doxid-class_e_e_1_1_string_1a91bff31a3c41e1458bac97631227ca4c>`& string,
			const :ref:`FontStyleConfig<doxid-class_e_e_1_1_graphics_1_1_font_style_config>`& fontStyle,
			:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` maxWidth,
			:ref:`LineWrapMode<doxid-namespace_e_e_1_1_u_i_1_1_doc_1a7d921083e01c5ebe7dec06364c9624f2>` mode,
			bool keepIndentation,
			:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` tabWidth = 4,
			:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` whiteSpaceWidth = 0.f,
			:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` textHints = :ref:`TextHints::None<doxid-struct_e_e_1_1_text_hints_1a6e0f42c67f78e9dc506ea074aab6863aa07c24bf3853a21214de780e518d4b8c5>`,
			bool tabStops = false,
			:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` initialXOffset = 0.f
		);
	
		static :ref:`LineWrapInfo<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_document_view_1_1_line_wrap_info>` :target:`computeLineBreaks<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a139144965d5800461e41d1f5a66e2fd7>`(
			const :ref:`String<doxid-class_e_e_1_1_string>`& string,
			const :ref:`FontStyleConfig<doxid-class_e_e_1_1_graphics_1_1_font_style_config>`& fontStyle,
			:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` maxWidth,
			:ref:`LineWrapMode<doxid-namespace_e_e_1_1_u_i_1_1_doc_1a7d921083e01c5ebe7dec06364c9624f2>` mode,
			bool keepIndentation,
			:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` tabWidth = 4,
			:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` whiteSpaceWidth = 0.f,
			:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` textHints = :ref:`TextHints::None<doxid-struct_e_e_1_1_text_hints_1a6e0f42c67f78e9dc506ea074aab6863aa07c24bf3853a21214de780e518d4b8c5>`,
			bool tabStops = false,
			:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` initialXOffset = 0.f
		);
	
		static :ref:`LineWrapInfo<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_document_view_1_1_line_wrap_info>` :target:`computeLineBreaks<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a5e8fe7aa62de17bf2d21c5b17b8a8bce>`(
			const :ref:`TextDocument<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_document>`& doc,
			size_t line,
			const :ref:`FontStyleConfig<doxid-class_e_e_1_1_graphics_1_1_font_style_config>`& fontStyle,
			:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` maxWidth,
			:ref:`LineWrapMode<doxid-namespace_e_e_1_1_u_i_1_1_doc_1a7d921083e01c5ebe7dec06364c9624f2>` mode,
			bool keepIndentation,
			:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` tabWidth = 4,
			:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` whiteSpaceWidth = 0.f,
			bool tabStops = false,
			:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` initialXOffset = 0.f
		);
	
		static :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :target:`computeOffsets<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1abc5822c3d2b5cae943e1a7ea8efcabd5>`(const :ref:`String::View<doxid-class_e_e_1_1_string_1a91bff31a3c41e1458bac97631227ca4c>`& string, const :ref:`FontStyleConfig<doxid-class_e_e_1_1_graphics_1_1_font_style_config>`& fontStyle, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` tabWidth, :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` maxWidth = 0.f, bool tabStops = false);
		bool :target:`isWrapEnabled<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1aba97ada410e012123a34f508a481d1a0>`() const;
		size_t :target:`getVisibleLinesCount<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a34349ca5350b4711d29f3f886bc462c1>`() const;
		const :ref:`Config<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_document_view_1_1_config>`& :target:`config<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1ac727caf0651dd60880c0898a0ff6cde3>`() const;
		void :target:`invalidateCache<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1aca82ca1b167dceade3529c1045339eab>`();
		void :target:`updateCache<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a0cb1f20ee89ca206084cdb0e22adf880>`(:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` fromLine, :ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` toLine, :ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` numLines);
		:ref:`Config<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_document_view_1_1_config>` :target:`getConfig<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1ab862246c5ae3d136a54c7034b8f31053>`() const;
		void :target:`setConfig<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a06451a57198b1941481e74aac4a9cfed>`(:ref:`Config<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_document_view_1_1_config>` config);
		void :target:`setMaxWidth<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a98e07237df3f9c5df1ff241f88b6e20d>`(:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` maxWidth, bool forceReconstructBreaks = false);
		void :target:`setFontStyle<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a3ebe338fe242b72fb8b12e2515747e9f>`(:ref:`FontStyleConfig<doxid-class_e_e_1_1_graphics_1_1_font_style_config>` fontStyle);
		void :target:`setLineWrapMode<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a267487f17b19c6afd17be0b1b9d5c843>`(:ref:`LineWrapMode<doxid-namespace_e_e_1_1_u_i_1_1_doc_1a7d921083e01c5ebe7dec06364c9624f2>` mode);
		:ref:`TextPosition<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_position>` :target:`getVisibleIndexPosition<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1ab9158afcbaf354b93d813c072a5551d6>`(:ref:`VisibleIndex<doxid-namespace_e_e_1_1_u_i_1_1_doc_1acc5f5361004a83332685638aef5f0644>` visibleIndex) const;
		:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :target:`getLinePadding<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1ac7a0a924287e5a10ae6000b43cc983be>`(:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` docIdx) const;
		:ref:`VisibleIndex<doxid-namespace_e_e_1_1_u_i_1_1_doc_1acc5f5361004a83332685638aef5f0644>` :target:`toVisibleIndex<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a30dc72b08dad1c65c0de4c1ced5a799d>`(:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` docIdx, bool retLast = false) const;
		bool :target:`isWrappedLine<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a2d81f7603f4cb9b0d96accc3d4ccdaae>`(:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` docIdx) const;
		:ref:`VisibleLineInfo<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_document_view_1_1_visible_line_info>` :target:`getVisibleLineInfo<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a4679838fcb8a7875413281910ae825ab>`(:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` docIdx) const;
		:ref:`VisibleLineRange<doxid-struct_e_e_1_1_u_i_1_1_doc_1_1_document_view_1_1_visible_line_range>` :target:`getVisibleLineRange<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a6f252e6eb2a896da0b7363ca5d79c021>`(const :ref:`TextPosition<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_position>`& pos, bool allowVisualLineEnd = false) const;
		:ref:`TextRange<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_range>` :target:`getVisibleIndexRange<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a65c08dcfa74545c1aeab1338bc666823>`(:ref:`VisibleIndex<doxid-namespace_e_e_1_1_u_i_1_1_doc_1acc5f5361004a83332685638aef5f0644>` visibleIndex) const;
		std::shared_ptr<:ref:`TextDocument<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_document>`> :target:`getDocument<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a9412167a70b0567d24c9f7ed56abce46>`() const;
		void :target:`setDocument<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a1bec2f02000ec7f67a4da2f80841e420>`(const std::shared_ptr<:ref:`TextDocument<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_document>`>& doc);
		bool :target:`isPendingReconstruction<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a4790f0807cd642ea1b52c39f7209ac5b>`() const;
		void :target:`setPendingReconstruction<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1acb6dc28f118eaa1ea94195c721d775f1>`(bool pendingReconstruction);
		void :target:`clear<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a09dd6865bca2de181287ad74b17c5e4e>`();
		void :target:`clearCache<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a5c70e4df300700d601581970f0622342>`();
		double :target:`getLineYOffset<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a00e7dcbf32108703e78ca626aedcf87c>`(:ref:`VisibleIndex<doxid-namespace_e_e_1_1_u_i_1_1_doc_1acc5f5361004a83332685638aef5f0644>` visibleIndex, :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` lineHeight) const;
		double :target:`getLineYOffset<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a326acba9168e2f83c8548a7018f0e064>`(:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` docIdx, :ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` lineHeight) const;
		bool :target:`isLineVisible<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a11d687db22f731788c170d5ede0f65c1>`(:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` docIdx) const;
		bool :target:`isFolded<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a99875af1283986bb984db46501005ea5>`(:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` docIdx, bool andNotFirstLine = false) const;
		std::optional<:ref:`TextRange<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_range>`> :target:`isInFoldedRange<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1abc754d0b0a60c54801be5148a198a1a8>`(:ref:`TextRange<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_range>` range, bool andNotFirstLine) const;
		void :target:`foldRegion<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1acb0c1c994ef92f226be77832eeca1bbb>`(:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` foldDocIdx);
		void :target:`unfoldRegion<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1ac1424d036653a7b2863ef320baf19b16>`(:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` foldDocIdx);
		bool :target:`isOneToOne<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a0a15f85a1a25767c6c692aa3f55c326a>`() const;
		std::vector<:ref:`TextRange<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_range>`> :target:`intersectsFoldedRegions<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a2e2a70012645dfce77d4948004567576>`(const :ref:`TextRange<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_range>`& range) const;
		:ref:`Float<doxid-namespace_e_e_1aebd0ddfb5fe01be63ea3e3a76330fef6>` :target:`getWhiteSpaceWidth<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1aba39c5358a443a0b13cb9d2dd3d6f385>`() const;
		void :target:`ensureCursorVisibility<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a3ed3996f5a22ea2bc8fc75eb823e7001>`();
		const std::vector<:ref:`TextRange<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_text_range>`> :target:`getFoldedRegions<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a992274d56090ed36f4f860e92ab9933d>`() const;
		void :target:`onFoldRegionsUpdated<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a613f03212f35aa0a941bc2270febd99b>`();
		void :target:`setOnVisibleLineCountChange<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1ace8e97ab67e4689dbd8ab267694f4009>`(std::function<void()> onVisibleLinesCountChangeCb);
		void :target:`setOnFoldUnfoldCb<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a96dca0cb90cab31d1b7063a5ddc8b684>`(std::function<void(:ref:`Int64<doxid-namespace_e_e_1a08ce4c6c46ed4d44737063c848bdf542>` docIdx, bool unfolded)> onFoldUnfoldCb);
		void :target:`setTabStops<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a52874057ff1f7cab2b255bf16c1296d6>`(bool enabled);
		bool :target:`usesTabStops<doxid-class_e_e_1_1_u_i_1_1_doc_1_1_document_view_1a09f5264d0fb5290d7446278b88873fc2>`() const;
	};