Offers a styled text ctrl with: More...

#include <wex/stc.h>

Inheritance diagram for wex::stc:

[legend]

Public Member Functions
	stc (const std::string &text=std::string(), const data::stc &data=data::stc())
	Constructors. More...

	stc (const wex::path &p, const data::stc &data=data::stc())
	Constructor, opens the file if it exists.

	~stc () override
	Destructor.

virtual bool	process_char (int c)
	Virtual interface. More...

auto *	auto_complete ()
	Other methods. More...

void	config_get ()
	Sets the configurable parameters to values currently in config.

const auto &	data () const
	Returns associated data.

void	filetype_menu ()
	Shows a menu with current line type checked, and allows you to change it.

bool	find_next (bool stc_find_string=true)
	Finds next with settings from find replace data.

auto &	get_file ()
	Returns the file.

auto	get_frame ()
	Returns frame.

const auto &	get_hexmode () const
	Returns hex mode component.

auto &	get_hexmode ()
	Returns writable hex mode component.

const vi &	get_vi () const
	Returns vi component.

vi &	get_vi ()
	Returns writable vi component. More...

bool	is_shown_line_numbers () const
	Returns true if line numbers are shown.

void	keep_event_data (bool synced)
	Keeps event data.

bool	marker_delete_all_change ()
	Deletes all change markers. More...

int	replace_all (const std::string &find_text, const std::string &replace_text)
	Replaces all text. More...

bool	replace_next (bool stc_find_string=true)
	Replaces text and calls find next. More...

bool	replace_next (const std::string &find_text, const std::string &replace_text, int find_flags=0, bool stc_find_string=true)
	Replaces text and calls find next. More...

bool	show_blame (const vcs_entry *vcs)
	Shows blame info for vcs in the text margin. More...

bool	CanCut () const override
	Virtual methods from wxWidgets.

void	add_text (const std::string &text) override
	Virtual methods from factory.

void	append_text (const std::string &text) override
	Appends text (to end).

bool	auto_indentation (int c) override
	After pressing enter, starts new line at same place as previous line.

bool	find (const std::string &text, int find_flags=-1, bool find_next=true) override
	Override methods from text_window.

void	fold (bool fold_all=false) override
	Enables or disables folding depending on fold property (default not implemented). More...

const ex_command &	get_ex_command () const override
	Returns a ex command.

const std::string	get_find_string () const override
	Returns find string, from selected text or from config. More...

bool	get_hexmode_erase (int begin, int end) override
	Hex erase.

bool	get_hexmode_insert (const std::string &command, int pos) override
	Hex insert.

std::string	get_hexmode_lines (const std::string &text) override
	Hex lines.

bool	get_hexmode_replace (char) override
	Hex replace.

bool	get_hexmode_replace_target (const std::string &replacement, bool set_text) override
	Hex replace target.

bool	get_hexmode_sync () override
	Hex sync.

int	get_current_line () const override
	Returns current line no.

int	get_line_count () const override
	Returns number of lines.

int	get_line_count_request () override
	Request for number of lines.

int	get_margin_text_click () const override
	Returns line on which text margin was clicked, or -1 if not.

const std::string	get_word_at_pos (int pos) const override
	Returns word at position.

void	goto_line (int line) override
	Goes to specified line.

bool	inject (const data::control &data) override
	Injects data.

bool	is_hexmode () const override
	Returns true if we are in hex mode (default false).

bool	is_visual () const override
	Returns true if we are in visual mode (default true).

bool	link_open () override
	If selected text is a link, opens the link.

bool	open (const wex::path &p, const data::stc &data=data::stc()) override
	Opens the file, reads the content into the window, then closes the file and sets the lexer.

const wex::path &	path () const override
	Returns the path, as used by the file. More...

bool	position_restore () override
	Restores saved position. More...

void	position_save () override
	Saves position.

void	print (bool prompt=true) override
	Prints the document.

void	print_preview (wxPreviewFrameModalityKind kind=wxPreviewFrame_AppModal) override
	Shows a print preview.

void	properties_message (path::log_t t=path::log_t().set(path::LOG_MOD)) override
	Shows properties on the statusbar using specified flags. More...

void	reset_margins (margin_t type=margin_t().set()) override
	Reset all margins. More...

bool	set_hexmode (bool on) override
	Sets hex mode (default false).

bool	set_indicator (const indicator &indicator, int start, int end) override
	Sets an indicator at specified start and end pos. More...

void	set_search_flags (int flags) override
	Sets search flags, default invokes SetSearchFlags. More...

void	set_text (const std::string &value) override
	Sets the text.

void	show_line_numbers (bool show) override
	Shows or hides line numbers.

void	sync (bool start=true) override
	Starts or stops syncing. More...

void	use_modification_markers (bool use) override
	Use and show modification markers in the margin. More...

bool	vi_command (const std::string &command) override
	Runs a vi command on this stc (default false).

void	vi_record (const std::string &command) override
	Records a macro.

std::string	vi_register (char c) const override
	Returns vi register.

int	vi_search_flags () const override
	Returns vi search flags.

const std::string	vi_mode () const override
	Returns vi mode as a string.

void	visual (bool on) override
	Sets using visual vi (on) or ex mode (!on).

Public Member Functions inherited from wex::factory::stc
const std::string	eol () const
	Other methods. More...

size_t	get_fold_level () const
	Returns current line fold level.

const auto &	get_lexer () const
	Returns the lexer.

auto &	get_lexer ()
	Returns the lexer.

const std::string	get_selected_text () const
	Returns selected text as a string.

const std::string	get_text () const
	Returns the text.

Public Member Functions inherited from wex::factory::text_window
virtual	~text_window ()=default
	Destructor.

Static Public Member Functions
static int	config_dialog (const data::window &data=data::window())
	Static interface. More...

static auto *	config_items ()
	Returns config items.

static auto *	get_config_dialog ()
	Returns the config dialog.

static void	on_exit ()
	Saves static data in config. More...

static void	on_init ()
	Reads static data from config (e.g. More...

Additional Inherited Members
Public Types inherited from wex::factory::stc
enum	{ MARGIN_DIVIDER = 0 , MARGIN_FOLDING = 1 , MARGIN_LINENUMBER = 2 , MARGIN_TEXT = 3 }
	Margin flags. More...

Detailed Description

Offers a styled text ctrl with:

ex or vi support (default vi mode is on)
find/replace
popup menu
printing

Constructor & Destructor Documentation

◆ stc()

wex::stc::stc	(	const std::string &	text = `std::string()`,
		const data::stc &	data = `data::stc()`
	)

Constructors.

Default constructor, sets text if not empty.

Member Function Documentation

◆ auto_complete()

auto* wex::stc::auto_complete ( )

inline

Other methods.

Returns auto_complete.

◆ config_dialog()

static int wex::stc::config_dialog ( const data::window & data = data::window() )

static

Static interface.

Shows a dialog with options, returns dialog return code. If used modeless, it uses the dialog id as specified, so you can use that id in frame::on_command_item_dialog.

◆ fold()

void wex::stc::fold ( bool fold_all = false )

overridevirtual

Enables or disables folding depending on fold property (default not implemented).

Parameters

fold_all if document contains more than 'Auto fold' lines, or if fold_all (and fold property is on) is specified, always all lines are folded.

Reimplemented from wex::factory::stc.

◆ get_find_string()

const std::string wex::stc::get_find_string ( ) const

overridevirtual

Returns find string, from selected text or from config.

The search flags are taken from frd. If text is selected, it also sets the find string.

Reimplemented from wex::factory::stc.

◆ get_vi()

vi& wex::stc::get_vi ( )

Returns writable vi component.

This allows you to do ex like editing:

get_vi().Command(":1,$s/xx/yy/g")
get_vi().Command(":w") to replace all xx by yy, and save the file.

◆ marker_delete_all_change()

bool wex::stc::marker_delete_all_change ( )

Deletes all change markers.

Returns false if marker change is not loaded.

◆ on_exit()

static void wex::stc::on_exit ( )

static

Saves static data in config.

Invoked once during app::on_exit.

◆ on_init()

static void wex::stc::on_init ( )

static

Reads static data from config (e.g.

zooming). Invoked once during app::OnInit.

◆ path()

const wex::path& wex::stc::path ( ) const

inlineoverridevirtual

Returns the path, as used by the file.

Pure virtual, must be overridden.

Implements wex::factory::stc.

◆ position_restore()

bool wex::stc::position_restore ( )

overridevirtual

Restores saved position.

Returns true if position was saved before.

Reimplemented from wex::factory::stc.

◆ process_char()

virtual bool wex::stc::process_char ( int c )

inlinevirtual

Virtual interface.

Processes specified char. Default does nothing, but is invoked during control_char_dialog, allowing you to add your own processing. Return true if char was processed.

Reimplemented in wex::shell.

◆ properties_message()

void wex::stc::properties_message ( path::log_t flags = path::log_t().set(path::LOG_MOD) )

overridevirtual

Shows properties on the statusbar using specified flags.

Default not implemented.

Reimplemented from wex::factory::stc.

◆ replace_all()

int wex::stc::replace_all	(	const std::string &	find_text,
		const std::string &	replace_text
	)

Replaces all text.

It there is a selection, it replaces in the selection, otherwise in the entire document. Returns the number of replacements.

◆ replace_next() [1/2]

bool wex::stc::replace_next ( bool stc_find_string = true )

Replaces text and calls find next.

Uses settings from find replace data.

◆ replace_next() [2/2]

bool wex::stc::replace_next	(	const std::string &	find_text,
		const std::string &	replace_text,
		int	find_flags = `0`,
		bool	stc_find_string = `true`
	)

Replaces text and calls find next.

It there is a selection, it replaces in the selection, otherwise it starts at current position.

Parameters

find_text	text to find
replace_text	text to replace with
find_flags	search flags to be used: wxSTC_FIND_WHOLEWORD wxSTC_FIND_MATCHCASE wxSTC_FIND_WORDSTART wxSTC_FIND_REGEXP wxSTC_FIND_POSIX if -1, use flags from find replace data
stc_find_string	argument passed on to find_next

◆ reset_margins()

void wex::stc::reset_margins ( margin_t type = margin_t().set() )

overridevirtual

Reset all margins.

Default not implemented.

Reimplemented from wex::factory::stc.

◆ set_indicator()

bool wex::stc::set_indicator	(	const indicator &	indicator,
		int	start,
		int	end
	)

overridevirtual

Sets an indicator at specified start and end pos.

Default false, not implemented.

Reimplemented from wex::factory::stc.

◆ set_search_flags()

void wex::stc::set_search_flags ( int flags )

overridevirtual

Sets search flags, default invokes SetSearchFlags.

search flags to be used:

wxSTC_FIND_WHOLEWORD
wxSTC_FIND_MATCHCASE
wxSTC_FIND_WORDSTART
wxSTC_FIND_REGEXP
wxSTC_FIND_POSIX

Reimplemented from wex::factory::stc.

◆ show_blame()

bool wex::stc::show_blame ( const vcs_entry * vcs )

Shows blame info for vcs in the text margin.

Returns true if info was added.

◆ sync()

void wex::stc::sync ( bool start = true )

overridevirtual

Starts or stops syncing.

Default syncing is started during construction.

Reimplemented from wex::factory::stc.

◆ use_modification_markers()

void wex::stc::use_modification_markers ( bool use )

overridevirtual

Use and show modification markers in the margin.

If you open a file, the modification markers are used.

Reimplemented from wex::factory::stc.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ stc()

Member Function Documentation

◆ auto_complete()

◆ config_dialog()

◆ fold()

◆ get_find_string()

◆ get_vi()

◆ marker_delete_all_change()

◆ on_exit()

◆ on_init()

◆ path()

◆ position_restore()

◆ process_char()

◆ properties_message()

◆ replace_all()

◆ replace_next() [1/2]

◆ replace_next() [2/2]

◆ reset_margins()

◆ set_indicator()

◆ set_search_flags()

◆ show_blame()

◆ sync()

◆ use_modification_markers()