gem-graph-client/doc/rtfm/man3/left.c.3

125 lines
2.6 KiB
Groff

.TH "src/widget/main_window/topbar/left.c" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/widget/main_window/topbar/left.c \- Topbar left design\&.
.SH SYNOPSIS
.br
.PP
\fC#include '\&.\&./\&.\&./\&.\&./\&.\&./include/base\&.h'\fP
.br
\fC#include '\&.\&./\&.\&./\&.\&./\&.\&./include/signal\&.h'\fP
.br
\fC#include '\&.\&./\&.\&./\&.\&./\&.\&./include/widget\&.h'\fP
.br
\fC#include '\&.\&./\&.\&./\&.\&./\&.\&./include/fsm\&.h'\fP
.br
.SS "Macros"
.in +1c
.ti -1c
.RI "#define \fBWANT_TO_START_ON_ANOTHER_PAGE\fP 0"
.br
.RI "default == SYNTH "
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "const char * \fBwidget_get_btt_label_synth\fP ()"
.br
.ti -1c
.RI "const char * \fBwidget_get_btt_label_state\fP ()"
.br
.ti -1c
.RI "const char * \fBwidget_get_btt_label_rules\fP ()"
.br
.ti -1c
.RI "const char * \fBwidget_get_btt_label_data\fP ()"
.br
.ti -1c
.RI "void \fBwindow_design_topbar_left\fP (GtkWidget *header_bar)"
.br
.in -1c
.SH "Detailed Description"
.PP
Topbar left design\&.
.PP
\fBWarning\fP
.RS 4
THE LABELS OF THE FOUR BUTTONS USED TO SELECT A PAGE IN THE MAIN WINDOW MUST ONLY BE DEFINED ONCE IN THE PROGRAM (in src/main_window/topbar/left/) AND ONLY USING ONE OF THE FOUR 'get_btt_label_' FUNCTIONS DEFINED IN THIS FILE
.RE
.PP
.SH "Function Documentation"
.PP
.SS "const char * widget_get_btt_label_data ()"
.PP
\fBReturns\fP
.RS 4
'data'
.RE
.PP
.SS "const char * widget_get_btt_label_rules ()"
.PP
\fBReturns\fP
.RS 4
'rules'
.br
.RE
.PP
.SS "const char * widget_get_btt_label_state ()"
.PP
\fBReturns\fP
.RS 4
'state'
.br
.RE
.PP
.SS "const char * widget_get_btt_label_synth ()"
.PP
\fBReturns\fP
.RS 4
'synth'
.br
.RE
.PP
.SS "void window_design_topbar_left (GtkWidget * header_bar)"
The rules page consists of two half-pages in a GtkPaned widget :
.IP "\(bu" 2
on the left, widgets for controlling or editing all the rules\&.
.IP "\(bu" 2
on the right, widgets for controlling or editing the selected rule\&.
.PP
.PP
As this division is clear and constant, it is simpler to place these two half-pages at the same hierarchical level as the other full pages like 'synth', 'state' or 'results'\&.
.PP
So there is no: 'widget_get_rules_page()' function\&. Instead, the distribution: 'all rules' versus 'the selected one' is moved to the file: 'signal'\&.
.PP
It is in the function: static void switch_state_rules_data() { switch (\fBfsm_get_state_rules_data()\fP) { \&.\&.\&. case (RULES) : GtkPaned *widget_all_vs_selected_one = \&.\&.\&. break; \&.\&.\&. }
.PP
\fBParameters\fP
.RS 4
\fI*header_bar\fP
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Gem-graph from the source code\&.