Geany  dev
Enumerations | Functions
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 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 new 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 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 and shows the messages window if it was previously hidden and show is set to TRUE. 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

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.

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

void msgwin_clear_tab ( gint  tabnum)

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

Parameters
tabnumAn 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
void msgwin_compiler_add ( gint  msg_color,
const gchar *  format,
  ... 
)

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

Parameters
msg_colorA color to be used for the text. It must be an element of MsgColors.
formatprintf()-style format string.
...Arguments for the format string.
void msgwin_msg_add ( gint  msg_color,
gint  line,
GeanyDocument doc,
const gchar *  format,
  ... 
)

Adds a new 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_colorA color to be used for the text. It must be an element of MsgColors.
lineThe document's line where the message belongs to. Set to -1 to ignore.
docThe document. Set to NULL to ignore.
formatprintf()-style format string.
...Arguments for the format string.
Since
0.15
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_dirThe directory.
void msgwin_status_add ( const gchar *  format,
  ... 
)

Logs a status message without setting the status bar.

(Use ui_set_statusbar() to display text on the statusbar)

Parameters
formatprintf()-style format string.
...Arguments for the format string.
void msgwin_switch_tab ( gint  tabnum,
gboolean  show 
)

Switches to the given notebook tab of the messages window and shows the messages window if it was previously hidden and show is set to TRUE.

Parameters
tabnumAn index of a tab in the messages window. Valid values are all elements of MessageWindowTabNum.
showWhether to show the messages window at all if it was hidden before.
Since
0.15