margins.c

Go to the documentation of this file.

/*
 * File Name: margins.c
 */

/*
 * This file is part of settings.
 *
 * settings 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.
 *
 * settings 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/>.
 */

/**
 * Copyright (C) 2008 iRex Technologies B.V.
 * All rights reserved.
 */

//----------------------------------------------------------------------------
// Include Files
//----------------------------------------------------------------------------

// system include files, between < >
#include <string.h>
#include <stdlib.h>
#include <unistd.h>
#include <stdio.h>

#include <gtk/gtk.h>
#include <gdk/gdk.h>
#include <glib.h>

#include <libergtk/ergtk.h>

#include "i18n.h"
#include "log.h"
#include "ipc.h"
#include "settings.h"
#include "settings_utils.h"
#include "settings_style.h"
#include "margins.h"


//----------------------------------------------------------------------------
// Type Declarations
//----------------------------------------------------------------------------

typedef struct
{
    int margin_horizontal;
    int margin_vertical;
} UdsSettings;

enum
{
    MARGIN_NONE = 0,
    MARGIN_NORMAL,
    MARGIN_MEDIUM,
    MARGIN_LARGE,
    NUM_MARGINS
} UdsMargins_e;


//----------------------------------------------------------------------------
// Global Constants
//----------------------------------------------------------------------------

static const int  DEFAULT_MARGIN = 20;

//----------------------------------------------------------------------------
// Static Variables
//----------------------------------------------------------------------------

static UdsSettings g_orig_uds_settings;
static UdsSettings g_cur_uds_settings;

static GtkWidget* g_margin_radios[NUM_MARGINS];  // Note: rely on compiler to initialise these to 0x00 == NULL

// Margins at 160dpi:
// 20 = 1/8" (~3mm)
// 40 = 1/4" (~6mm)
// 80 = 1/2" (~1.2mm)

static int g_margins_horizontal[NUM_MARGINS] = { 0,  20,  40,  80 };  // pixels
static int g_margins_vertical  [NUM_MARGINS] = { 0,  20,  40,  80 };  // pixels

//============================================================================
// Local Function Definitions
//============================================================================

static GtkWidget* create_margin_widgets         (GtkBox* parent);

static void on_margin_changed                   (GtkWidget *widget, gpointer data);
static void init_widgets_with_settings          (void);
static void on_listview_row_activated ( GtkTreeView       *view,
                                        GtkTreePath       *path,
                                        GtkTreeViewColumn *column,
                                        gpointer          user_data );


static void on_listview_navigate_cursor ( erGtkListView         *er_listview,
        erGtkListViewKeyPress keycode,
        gpointer              user_data );

static gboolean on_focus_in(GtkWidget* widget, gpointer data );
static gboolean on_focus_out(GtkWidget* widget, gpointer data );

//============================================================================
// Functions Implementation
//============================================================================

GtkWidget* create_margins_window(GtkWidget* parent)
{
    LOGPRINTF("entry");

    bzero(g_margin_radios, 2);

    // create top window
    GtkWidget* top_window = parent;
    gtk_window_maximize(GTK_WINDOW(top_window));
    gtk_window_set_resizable(GTK_WINDOW(top_window), FALSE);
    gtk_container_set_border_width(GTK_CONTAINER(top_window),WINDOW_BORDER_PADDING  );
    gtk_window_set_modal(GTK_WINDOW(top_window), TRUE);

    // top level vbox (vboxtop)
    GtkWidget* vboxtop = gtk_vbox_new(FALSE, 3);
    gtk_container_add(GTK_CONTAINER(top_window), vboxtop);

    // add header container the title and subtitle of this settings page
    create_title(GTK_VBOX(vboxtop), _("Settings"), _("Page Margins"));
    
    // add the back/exit bar below the title 
    GtkWidget* view = create_settingsview();
    gtk_box_pack_start(GTK_BOX(vboxtop), view, FALSE, FALSE,0 ); 
    g_signal_connect(view, "row-activated", G_CALLBACK(on_listview_row_activated), NULL ) ;
    g_signal_connect(view, "navigate-cursor", G_CALLBACK(on_listview_navigate_cursor), NULL ) ;
    g_signal_connect(view, "focus-in-event", G_CALLBACK(on_focus_in), NULL );
    g_signal_connect(view, "focus-out-event", G_CALLBACK(on_focus_out), NULL );

    // add an alignment below the exit bar
    GtkWidget* alignment = gtk_alignment_new(0, 0, 1.0, 0.0);
    gtk_container_add(GTK_CONTAINER(vboxtop), alignment);

    // introdude a frame in the alignment
    GtkWidget* frame = gtk_frame_new(NULL);
    gtk_widget_set_name(frame, "irex-margins-frame");
    gtk_container_add(GTK_CONTAINER(alignment), frame);
    gtk_container_set_border_width(GTK_CONTAINER(frame), 3);

    // alignment in frame 
    GtkWidget* alignment2 = gtk_alignment_new(0.0, 0.0, 1.0, 1.0);
    gtk_container_add(GTK_CONTAINER(frame), alignment2);
    gtk_alignment_set_padding(GTK_ALIGNMENT(alignment2),
                              WINDOW_TOP_ALT_PADDING,
                              WINDOW_BOTTOM_PADDING,
                              WINDOW_H_PADDING,
                              WINDOW_H_PADDING);
   
    // vbox in alignment2
    GtkWidget* innervbox = gtk_vbox_new(FALSE, SMALL_SPACING);
    gtk_container_add(GTK_CONTAINER(alignment2), innervbox);
    
    // The margin settings section.
    create_margin_widgets(GTK_BOX(innervbox));

    // Update widget with current settings.
    init_widgets_with_settings();

    gtk_widget_grab_focus(view);

    gtk_widget_show_all(top_window);
    return top_window;
}



//============================================================================
// Local Functions Implementation
//============================================================================

static void on_listview_row_activated ( GtkTreeView       *view,
                                        GtkTreePath       *path,
                                        GtkTreeViewColumn *column,
                                        gpointer          user_data )
{
    LOGPRINTF("entry");

    save_margins_settings();

    main_quit();

    return;
}

static void on_listview_navigate_cursor ( erGtkListView         *er_listview,
        erGtkListViewKeyPress keycode,
        gpointer              user_data )
{
    LOGPRINTF("entry");

    GtkTreeSelection* my_selection = gtk_tree_view_get_selection((GtkTreeView*) er_listview);
    g_assert( my_selection != NULL ) ;

    // determine new cursor position
    switch (keycode)
    {
        case ERGTK_LIST_VIEW_PRESS_SHORT_DOWN:
        case ERGTK_LIST_VIEW_PRESS_LONG_DOWN:
            gtk_widget_grab_focus(GTK_WIDGET(g_margin_radios[0]));
            gtk_tree_selection_unselect_all(my_selection);
            break;
        default:
            LOGPRINTF("illegal erGtkListViewKeyPress [%d]", keycode);
            ;  // ignore
            break;
    }
}

//============================================================================
// Functions Implementation
//============================================================================


void load_margins_settings()
{
    int val;
    int margins[] = { DEFAULT_MARGIN,
                      DEFAULT_MARGIN,
                      DEFAULT_MARGIN,
                      DEFAULT_MARGIN };
    GArray *values = NULL;
    
    LOGPRINTF("entry");

    values = get_int_array(GCONF_PAGE_MARGINS);
    if (values && values->len > 0)
    {
        unsigned int i;
        for ( i = 0 ;
              i < sizeof(margins)/sizeof(margins[0])  &&  i < values->len ;
              i++ )
        {
            val = g_array_index(values, int, i);
            if (val >= 0)
            {
                // valid margin setting
                margins[i] = val;
            }
        }
    }

    // Note: gconf margin left   -> use as horizontal margin
    //       gconf margin right  -> ignore (for now)
    //       gconf margin top    -> use as vertical margin
    //       gconf margin bottom -> ignore (for now)
    g_orig_uds_settings.margin_horizontal = margins[0];
    g_orig_uds_settings.margin_vertical   = margins[2];

    g_cur_uds_settings = g_orig_uds_settings;

    // clean up
    if (values) { g_array_free(values, TRUE); }
}


void save_margins_settings()
{
    GArray *values = NULL;
    
    LOGPRINTF("entry");

    if (   g_cur_uds_settings.margin_horizontal != g_orig_uds_settings.margin_horizontal
        || g_cur_uds_settings.margin_vertical   != g_orig_uds_settings.margin_vertical  )
    {
        values = g_array_new(FALSE, FALSE, sizeof(int));
        g_array_append_val(values, g_cur_uds_settings.margin_horizontal);  // left
        g_array_append_val(values, g_cur_uds_settings.margin_horizontal);  // right
        g_array_append_val(values, g_cur_uds_settings.margin_vertical);    // top
        g_array_append_val(values, g_cur_uds_settings.margin_vertical);    // bottom

        set_int_array(GCONF_PAGE_MARGINS, values);
        g_orig_uds_settings =  g_cur_uds_settings;
    }

    LOGPRINTF("Saving margin settings, done.");

    // clean up
    if (values) { g_array_free(values, TRUE); }
}


//============================================================================
// Local Functions Implementation
//============================================================================


static GtkWidget* create_radio_button_item(GtkWidget* group, gchar* title, gchar* subtitle)
{
    LOGPRINTF("entry");

    GtkWidget* radio_button = NULL ;
    if ( group == NULL ) 
    {
        radio_button = gtk_radio_button_new(NULL); 
    }
    else {
        radio_button = gtk_radio_button_new_from_widget(GTK_RADIO_BUTTON(group)); 

    }
    gtk_widget_set_name(radio_button, "irex-settings-checkbutton");

    // alignment in radio button for some padding
    GtkWidget* align = gtk_alignment_new(0, 0.0, 1.0, 1.0);
    gtk_container_add(GTK_CONTAINER(radio_button), align);
    gtk_alignment_set_padding(GTK_ALIGNMENT(align)
                                , 6 // top
                                , 6 // bottom
                                , 6 // left
                                , 6 // right
            );
 
    // vbox in radio button
    GtkWidget* radiovbox = gtk_vbox_new( FALSE, 0);
    gtk_container_add(GTK_CONTAINER(align), radiovbox);

    // top level label for radio button ( no margins )
    GtkWidget* label = gtk_label_new( title );
    gtk_widget_set_name(label, "irex-radio-title");
    gtk_misc_set_alignment(GTK_MISC(label), 0.0, 0.0);
    gtk_box_pack_start(GTK_BOX(radiovbox), label, FALSE, FALSE, 0);

    // second level label for radio button ( descriptive test )
    label = gtk_label_new( subtitle  );
    gtk_widget_set_name(label, "irex-radio-subtitle");
    gtk_misc_set_alignment(GTK_MISC(label), 0.0, 0.0);
    gtk_label_set_line_wrap(GTK_LABEL(label), TRUE);
    gtk_widget_set_size_request(label, SETTINGS_LABEL_MAX_WIDTH - 40 , -1);
    gtk_box_pack_start(GTK_BOX(radiovbox), label, FALSE, FALSE, 0);

    return radio_button;
}



// Widget Hierarchy
// |--Top Level vbox
//    |--label ("UDS settings")
//    |--label ("Choose the page margin")
//    |--vbox
//       |--radio
//       |--radio
//       |--radio
//       |--radio
static GtkWidget* create_margin_widgets(GtkBox* parent)
{
    LOGPRINTF("entry");

    // Top level vbox.
    GtkWidget* top_level_vbox = gtk_vbox_new(FALSE, ITEM_SPACING);
    gtk_box_pack_start(parent, top_level_vbox, FALSE, FALSE, 0);

    // The vbox containing radio buttons.
    GtkWidget* vbox = gtk_vbox_new(TRUE, 10);
    gtk_box_pack_start(GTK_BOX(top_level_vbox), vbox, FALSE, FALSE, 0);

    int i = 0 ;
    for (i=0; i<NUM_MARGINS; i++)
    {
        switch (i)
        {
            case 0:
            {
                // the radio button "No Margins"
                g_margin_radios[i] = create_radio_button_item(NULL, _("No Margins"), _("Allows the text in a book to run to the edges of the screen."));
                
                break;
            }
            case 1:
            {
                // The radio button "Normal margins".
                g_margin_radios[i] = create_radio_button_item(g_margin_radios[0], _("Normal Margins")
                        , _("Leaves 1/8\" of white space around the text in a book."));
                
                break;
            }
            case 2:
            {
                // The radio button "Medium Margins".
                g_margin_radios[i] = create_radio_button_item(g_margin_radios[0], _("Medium Margins")
                        , _("Leaves 1/4\" of white space around the text in a book."));
                break;
            }
            case 3:
            {
                // The radio button "Large Margins".
                g_margin_radios[i] = create_radio_button_item(g_margin_radios[0], _("Large Margins")
                        , _("Leaves 1/2\" of white space around the text in a book."));
                break;
            }
            default:
            {
                // never happens
                break;
            }
        }

        // Add signal handler.
        g_signal_connect_after(G_OBJECT(g_margin_radios[i]),
            "toggled",
            G_CALLBACK(on_margin_changed),
            (gpointer)i);

        gtk_box_pack_start(GTK_BOX(vbox), g_margin_radios[i], FALSE, FALSE, 0);
    }

    return top_level_vbox;
}


static void on_margin_changed(GtkWidget *widget, gpointer data)
{
    int index = (int)data;
    gboolean is_active = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(widget));

    LOGPRINTF("entry");

    if (is_active == TRUE )
    {
        if (index >= 0 && index < NUM_MARGINS)
        {
            g_cur_uds_settings.margin_horizontal = g_margins_horizontal[index];
            g_cur_uds_settings.margin_vertical   = g_margins_vertical  [index];
        }
        else
        {
            ERRORPRINTF("Invalid index [%d]", index);
        }
    }
}

static void init_widgets_with_settings()
{
    int i;
    int to_be_activated = MARGIN_NORMAL;

    LOGPRINTF("entry");

    for (i = 0; i < NUM_MARGINS; i++)
    {
        if (   g_cur_uds_settings.margin_horizontal == g_margins_horizontal[i]
            && g_cur_uds_settings.margin_vertical   == g_margins_vertical  [i] )
        {
            to_be_activated = i;
            break;  // exit for
        }
    }

    for (i = 0; i < NUM_MARGINS; i++)
    {
        gtk_toggle_button_set_active( GTK_TOGGLE_BUTTON(g_margin_radios[i]),
                                      (i == to_be_activated) ? TRUE : FALSE );
    }
}

static gboolean on_focus_in(GtkWidget* widget, gpointer data )
{
    LOGPRINTF("entry");

    g_assert(widget != NULL ) ;
    ergtk_list_view_set_cursor( ERGTK_LIST_VIEW(widget), 0); // row = 0;
    return FALSE;
}

static gboolean on_focus_out(GtkWidget* widget, gpointer data )
{
    LOGPRINTF("entry");

    g_assert(widget != NULL ) ;
    GtkTreeSelection* my_selection = gtk_tree_view_get_selection((GtkTreeView*) widget);
    g_assert( my_selection != NULL ) ;
    gtk_tree_selection_unselect_all(my_selection);
    return FALSE;
}