notify2.h File Reference

Colour notifications. More...

#include "config.h"
#include "mutt/lib.h"
#include "color.h"

Include dependency graph for notify2.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	EventColor
	An Event that happened to a Colour. More...

Enumerations
enum	NotifyColor { NT_COLOR_SET = 1 , NT_COLOR_RESET }
	Types of Color Event. More...

Functions
void	color_notify_init (struct Notify *parent)
	Initialise the Colour notification.
void	color_notify_cleanup (void)
	Free the Colour notification.
void	mutt_color_observer_add (observer_t callback, void *global_data)
	Add an observer.
void	mutt_color_observer_remove (observer_t callback, void *global_data)
	Remove an observer.

Variables
struct Notify *	ColorsNotify
	Notifications: ColorId, EventColor.

Detailed Description

Colour notifications.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file notify2.h.

Enumeration Type Documentation

NotifyColor

enum NotifyColor

Types of Color Event.

Observers of NT_COLOR will be passed an EventColor.

Note

Notifications are sent after the event.

Enumerator
NT_COLOR_SET	Color has been set.
NT_COLOR_RESET	Color has been reset/removed.

Definition at line 41 of file notify2.h.

{
  NT_COLOR_SET = 1, 
  NT_COLOR_RESET,   
};

Function Documentation

color_notify_init()

void color_notify_init

(

struct Notify *

parent

)

Initialise the Colour notification.

Parameters

parent

Parent notification object

Definition at line 42 of file notify.c.

{
  ColorsNotify = notify_new();
  notify_set_parent(ColorsNotify, parent);
}

Here is the call graph for this function:

Here is the caller graph for this function:

color_notify_cleanup()

void color_notify_cleanup

(

void

)

Free the Colour notification.

Definition at line 51 of file notify.c.

{
  notify_free(&ColorsNotify);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_color_observer_add()

void mutt_color_observer_add	(	observer_t	callback,
		void *	global_data
	)

Add an observer.

Parameters

callback	The callback
global_data	The data

Definition at line 61 of file notify.c.

{
  notify_observer_add(ColorsNotify, NT_COLOR, callback, global_data);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_color_observer_remove()

void mutt_color_observer_remove	(	observer_t	callback,
		void *	global_data
	)

Remove an observer.

Parameters

callback	The callback
global_data	The data

Definition at line 71 of file notify.c.

{
  notify_observer_remove(ColorsNotify, callback, global_data);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

ColorsNotify

struct Notify* ColorsNotify

extern

Notifications: ColorId, EventColor.

Definition at line 36 of file notify.c.