msgwindow.h File Reference

Message window functions (status, compiler, messages windows). More...

Enumerations
enum	MessageWindowTabNum {   MSG_STATUS = 0 , MSG_COMPILER , MSG_MESSAGE , MSG_SCRATCH ,   MSG_VTE }
	Indices of the notebooks in the messages window. More...
enum	MsgColors { COLOR_RED , COLOR_DARK_RED , COLOR_BLACK , COLOR_BLUE }
	Various colors for use in the compiler and messages treeviews when adding messages. More...

Functions
void	msgwin_clear_tab (gint tabnum)
	Removes all messages from a tab specified by tabnum in the messages window. More...
void	msgwin_compiler_add (gint msg_color, const gchar *format,...)
	Adds a formatted message in the compiler tab treeview in the messages window. More...
void	msgwin_compiler_add_string (gint msg_color, const gchar *msg)
	Adds a new message in the compiler tab treeview in the messages window. More...
void	msgwin_msg_add (gint msg_color, gint line, GeanyDocument *doc, const gchar *format,...)
	Adds a formatted message in the messages tab treeview in the messages window. More...
void	msgwin_set_messages_dir (const gchar *messages_dir)
	Sets the Messages path for opening any parsed filenames without absolute path from message lines. More...
void	msgwin_status_add (const gchar *format,...)
	Logs a formatted status message without setting the status bar. More...
void	msgwin_status_add_string (const gchar *msg)
	Logs a new status message without setting the status bar. More...
void	msgwin_switch_tab (gint tabnum, gboolean show)
	Switches to the given notebook tab of the messages window. More...

Detailed Description

Message window functions (status, compiler, messages windows).

Also compiler error message parsing and grep file and line parsing.

See also

GeanyMainWidgets::message_window_notebook to append a new notebook page.

Enumeration Type Documentation

MessageWindowTabNum

enum MessageWindowTabNum

Indices of the notebooks in the messages window.

Enumerator
MSG_STATUS	Index of the status message tab.
MSG_COMPILER	Index of the compiler tab.
MSG_MESSAGE	Index of the messages tab.
MSG_SCRATCH	Index of the scratch tab.
MSG_VTE	Index of the VTE tab.

MsgColors

enum MsgColors

Various colors for use in the compiler and messages treeviews when adding messages.

Enumerator
COLOR_RED	Color red.
COLOR_DARK_RED	Color dark red.
COLOR_BLACK	Color black.
COLOR_BLUE	Color blue.

Function Documentation

msgwin_clear_tab()

void msgwin_clear_tab

(

gint

tabnum

)

Removes all messages from a tab specified by tabnum in the messages window.

Parameters

tabnum

An index of a tab in the messages window which should be cleared. Valid values are MSG_STATUS, MSG_COMPILER and MSG_MESSAGE.

Since

0.15

msgwin_compiler_add()

void msgwin_compiler_add	(	gint	msg_color,
		const gchar *	format,
			...
	)

Adds a formatted message in the compiler tab treeview in the messages window.

Parameters

msg_color	A color to be used for the text. It must be an element of MsgColors.
format	printf()-style format string.
...	Arguments for the format string.

See also

msgwin_compiler_add_string()

Since

0.16

msgwin_compiler_add_string()

void msgwin_compiler_add_string	(	gint	msg_color,
		const gchar *	msg
	)

Adds a new message in the compiler tab treeview in the messages window.

Parameters

msg_color	A color to be used for the text. It must be an element of MsgColors.
msg	Compiler message to be added.

See also

msgwin_compiler_add()

Since

1.34 (API 236)

msgwin_msg_add()

void msgwin_msg_add	(	gint	msg_color,
		gint	line,
		GeanyDocument *	doc,
		const gchar *	format,
			...
	)

Adds a formatted message in the messages tab treeview in the messages window.

If line and doc are set, clicking on this line jumps into the file which is specified by doc into the line specified with line.

Parameters

msg_color	A color to be used for the text. It must be an element of MsgColors.
line	The document's line where the message belongs to. Set to -1 to ignore.
doc	The document. Set to NULL to ignore.
format	printf()-style format string.
...	Arguments for the format string.

See also

msgwin_msg_add_string()

Since

0.16

msgwin_set_messages_dir()

void msgwin_set_messages_dir

(

const gchar *

messages_dir

)

Sets the Messages path for opening any parsed filenames without absolute path from message lines.

Parameters

messages_dir

The directory.

msgwin_status_add()

void msgwin_status_add	(	const gchar *	format,
			...
	)

Logs a formatted status message without setting the status bar.

Use ui_set_statusbar() to display text on the statusbar.

Parameters

format	printf()-style format string.
...	Arguments for the format string.

See also

msgwin_status_add_string()

Since

0.12

msgwin_status_add_string()

void msgwin_status_add_string

(

const gchar *

string

)

Logs a new status message without setting the status bar.

Use ui_set_statusbar() to display text on the statusbar.

Parameters

string

Status message to be logged.

See also

msgwin_status_add()

Since

1.34 (API 236)

msgwin_switch_tab()

void msgwin_switch_tab	(	gint	tabnum,
		gboolean	show
	)

Switches to the given notebook tab of the messages window.

The messages window is shown if it was previously hidden and show is set to TRUE.

Parameters

tabnum	An index of a tab in the messages window. Valid values are all elements of MessageWindowTabNum.
show	Whether to show the messages window at all if it was hidden before.

Since

0.15