aboutsummaryrefslogtreecommitdiff
path: root/lib/gtk-experiment-widgets/gtk-experiment-transcript.h
blob: fc732858efec3a5d8f7ce1c377c7cab1c17c0875 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/**
 * @file
 * Header file necessary to include when using the \e GtkExperimentTranscript
 * widget.
 */

/*
 * Copyright (C) 2012 Otto-von-Guericke-Universität Magdeburg
 *
 * 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 3 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/>.
 */

#ifndef __GTK_EXPERIMENT_TRANSCRIPT_H
#define __GTK_EXPERIMENT_TRANSCRIPT_H

#include <glib-object.h>
#include <gdk/gdk.h>

#include <gtk/gtk.h>

#include <experiment-reader.h>

G_BEGIN_DECLS

#define GTK_TYPE_EXPERIMENT_TRANSCRIPT \
	(gtk_experiment_transcript_get_type())
/**
 * Cast instance pointer to \e GtkExperimentTranscript
 *
 * @param obj Object to cast to \e GtkExperimentTranscript
 * @return \e obj casted to \e GtkExperimentTranscript
 */
#define GTK_EXPERIMENT_TRANSCRIPT(obj) \
	(G_TYPE_CHECK_INSTANCE_CAST((obj), GTK_TYPE_EXPERIMENT_TRANSCRIPT, GtkExperimentTranscript))
#define GTK_EXPERIMENT_TRANSCRIPT_CLASS(klass) \
	(G_TYPE_CHECK_CLASS_CAST((klass), GTK_TYPE_EXPERIMENT_TRANSCRIPT, GtkExperimentTranscriptClass))
#define GTK_IS_EXPERIMENT_TRANSCRIPT(obj) \
	(G_TYPE_CHECK_INSTANCE_TYPE((obj), GTK_TYPE_EXPERIMENT_TRANSCRIPT))
#define GTK_IS_EXPERIMENT_TRANSCRIPT_CLASS(klass) \
	(G_TYPE_CHECK_CLASS_TYPE((klass), GTK_TYPE_EXPERIMENT_TRANSCRIPT))
#define GTK_EXPERIMENT_TRANSCRIPT_GET_CLASS(obj) \
	(G_TYPE_INSTANCE_GET_CLASS((obj), GTK_TYPE_EXPERIMENT_TRANSCRIPT, GtkExperimentTranscriptClass))

/** @private */
typedef struct _GtkExperimentTranscriptPrivate GtkExperimentTranscriptPrivate;

/**
 * \e GtkExperimentTranscript instance structure
 */
typedef struct _GtkExperimentTranscript {
	GtkWidget parent_instance;		/**< Parent instance structure */

	gchar *speaker;				/**< Name of speaker whose contributions are displayed (\b read-only) */
	gboolean reverse;			/**< Reverse mode (\b read-write) */

	struct _GtkExperimentTranscriptInteractiveFormat {
		PangoFontDescription *default_font;	/**< Default interactive format font */
		GdkColor *default_text_color;		/**< Default interactive format text color */
		GdkColor *default_bg_color;		/**< Default interactive format background color */
	} interactive_format;

	GtkExperimentTranscriptPrivate *priv;	/**< @private Pointer to \b private instance attributes */
} GtkExperimentTranscript;

/**
 * \e GtkExperimentTranscript class structure
 */
typedef struct _GtkExperimentTranscriptClass {
	GtkWidgetClass parent_class;	/**< Parent class structure */
} GtkExperimentTranscriptClass;

/** @private */
GType gtk_experiment_transcript_get_type(void);

/*
 * API
 */
GtkWidget *gtk_experiment_transcript_new(const gchar *speaker);

gboolean gtk_experiment_transcript_load(GtkExperimentTranscript *trans,
					ExperimentReader *exp);
gboolean gtk_experiment_transcript_load_filename(GtkExperimentTranscript *trans,
						 const gchar *filename);

void gtk_experiment_transcript_set_alignment(GtkExperimentTranscript *trans,
					     PangoAlignment alignment);
PangoAlignment gtk_experiment_transcript_get_alignment(GtkExperimentTranscript *trans);

gboolean gtk_experiment_transcript_load_formats(GtkExperimentTranscript *trans,
						const gchar *filename);
gboolean gtk_experiment_transcript_set_interactive_format(GtkExperimentTranscript *trans,
							  const gchar *format_str,
							  gboolean with_markup);

GtkAdjustment *gtk_experiment_transcript_get_time_adjustment(GtkExperimentTranscript *trans);
void gtk_experiment_transcript_set_time_adjustment(GtkExperimentTranscript *trans,
						   GtkAdjustment *adj);

G_END_DECLS

#endif