rotation.c

Go to the documentation of this file.

/*
 * File Name: rotation.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) 2010 IREX Technologies B.V.
 * All rights reserved.
 */

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

// system include files, between < >

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

#include <libergtk/ergtk.h>

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

#include "rotation.h"


//----------------------------------------------------------------------------
// Type Declarations
//----------------------------------------------------------------------------
  
typedef enum
{
    /* Has only effect in landscape orientation */
    Rotation_Clockwise,      /* normal: upkey -> next page */
    Rotation_Anti_Clockwise  /* normal: upkey -> prev page */
} RotationDirection;


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

#define NUM_ROTATION_MODES  2


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

static RotationDirection g_orig_rotation_settings;
static RotationDirection g_cur_rotation_settings;

static GtkWidget* g_rotation_settings_radios[NUM_ROTATION_MODES];  

static const GdkColor grey = { 0, 0x5500, 0x5500, 0x5500 }; //TODO define in settings_style.h

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

static GtkWidget* create_rotation_settings_widgets         (GtkBox* parent);

static void on_rotation_settings_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_rotation_window(GtkWidget* parent)
{
    LOGPRINTF(" create_rotation_window \n");

    // 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"), _("Rotation Direction"));
    
    // 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, 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_rotation_settings_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(" on_listview_row_activated "); 
    save_rotation_settings();

    main_quit();
    return;
}

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

    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_rotation_settings_radios[0])); // down: to first widget
            gtk_tree_selection_unselect_all(my_selection);
            break;
        default:
            LOGPRINTF("illegal erGtkListViewKeyPress [%d]", keycode);
            ;  // ignore
            break;
    }

}

static gboolean on_focus_in(GtkWidget* widget, gpointer data )
{
    LOGPRINTF(" on_focus_in "); 
    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(" on_focus_out ");   
    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;
}


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


void load_rotation_settings()
{
    LOGPRINTF(" load_rotation_settings "); 
    const char* rotation          = NULL;
    
    // Get rotation direction.
    rotation = get_value_string(GCONF_ROTATION_DIRECTION);
    if (strcmp(rotation, "clockwise") == 0)
    {
        g_orig_rotation_settings = Rotation_Clockwise;
    }
    else
    {
        g_orig_rotation_settings = Rotation_Anti_Clockwise;
    }
    
    g_cur_rotation_settings = g_orig_rotation_settings;
}


void save_rotation_settings()
{
    LOGPRINTF(" save_rotation_settings ");  
    // Set rotation direction if necessary.
    if (g_cur_rotation_settings != g_orig_rotation_settings)
    {
        set_value_string(GCONF_ROTATION_DIRECTION,
            (g_cur_rotation_settings == Rotation_Clockwise) ? "clockwise" : "anticlockwise");
    }

    LOGPRINTF("Saving rotation settings, done.");
}


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


// radiobutton
// |--align
//    |--hbox
//       |--icon
//       |--align2
//          |--vbox
//             |-- title
//             |-- subtitle 
static GtkWidget* create_radio_button_icon_item(GtkWidget* group, gchar* title, gchar* subtitle, gchar* icon)
{
    LOGPRINTF(" create_radio_button_icon_item "); 
    GtkWidget* radio_button = NULL;


    if ( group == NULL ) // create first radiobutton
    {
        radio_button = gtk_radio_button_new(NULL);  
    }
    else // create next radiobutton
    {
        radio_button = gtk_radio_button_new_from_widget(GTK_RADIO_BUTTON(group)); 
    }
    
    gtk_widget_set_name(radio_button, "irex-settings-checkbutton"); // sets style

    // 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),
                             WINDOW_TOP_ALT_PADDING,
                             WINDOW_BOTTOM_PADDING,
                             WINDOW_H_PADDING,
                             WINDOW_H_PADDING);

    // hbox in radio button for icon and labels.
    GtkWidget* radiohbox = gtk_hbox_new(FALSE, SMALL_SPACING * 3);
    gtk_container_add(GTK_CONTAINER(align), radiohbox);

    // Add icon image
    GtkWidget* image = gtk_image_new_from_file(icon);
    gtk_box_pack_start(GTK_BOX(radiohbox), image, FALSE, FALSE, 0);

    // For layout purposes of text lengths, add align container
    GtkWidget* align2 = gtk_alignment_new(0, 0, 1.0, 1.0); 
    gtk_container_add(GTK_CONTAINER(radiohbox), align2);
    gtk_alignment_set_padding(GTK_ALIGNMENT(align2),
                             WINDOW_TOP_ALT_PADDING,
                             WINDOW_BOTTOM_PADDING,
                             WINDOW_H_PADDING,
                             WINDOW_H_PADDING);

    // vbox for label and description
    GtkWidget* radiovbox = gtk_vbox_new(FALSE, SMALL_SPACING);
    gtk_container_add(GTK_CONTAINER(align2), radiovbox);
    
    // label for radio button 
    GtkWidget* item = subject_create();
    gtk_label_set_label(GTK_LABEL(item), title);
    gtk_box_pack_start(GTK_BOX(radiovbox), item, FALSE, FALSE, 0);

    // second level label for radio button : descriptive test 
    GtkWidget* desc = description_create();
    gtk_label_set_label(GTK_LABEL(desc), subtitle);
    gtk_widget_set_size_request(desc, SETTINGS_LABEL_MAX_WIDTH, -1); // force size calculation at maximum width, also in landscape
    gtk_widget_modify_fg(desc, GTK_STATE_ACTIVE, &grey); //keep grey on active choice
    gtk_box_pack_start(GTK_BOX(radiovbox), desc, FALSE, FALSE, 0);

    return radio_button;
}



// Widget Hierarchy
// |--Top Level vbox
//    |--label ("Choose the rotation direction")
//    |--vbox
//       |--radiobutton ("Clockwise")
//       |--radiobutton ("Anticlockwise")
static GtkWidget* create_rotation_settings_widgets(GtkBox* parent)
{
    LOGPRINTF(" create_rotation_settings_widgets ");   
    // 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_ROTATION_MODES; i++)
    {
        switch (i)
        {
            case 0:
            {
                // the radio button "Clockwise Rotation"
                g_rotation_settings_radios[i] = create_radio_button_icon_item(NULL, _("Clockwise")
                        , _("Rotate clockwise for left-handed use."),
                        DATADIR"/rotation-clockwise.png");
                break;
            }
            case 1:
            {
                // The radio button "Anticlockwise Rotation"
                g_rotation_settings_radios[i] = create_radio_button_icon_item(g_rotation_settings_radios[0], _("Anticlockwise")
                        , _("Rotate anticlockwise for right-handed use"),
                        DATADIR"/rotation-anticlockwise.png");
                break;
            }
            default:
            {
                LOGPRINTF(" never happens ");
                // never happens
                break;
            }
        }

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

        gtk_box_pack_start(GTK_BOX(vbox), g_rotation_settings_radios[i], FALSE, FALSE, 0);
    }
    
    return top_level_vbox;
}


static void on_rotation_settings_changed(GtkWidget *widget, gpointer data)
{
    LOGPRINTF(" on_rotation_settings_changed "); 
    int index = (int)data;

    g_assert( 0 <= index );
    g_assert( index < NUM_ROTATION_MODES );

    gboolean is_active = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(widget));

    if (is_active == TRUE )
    {
        switch (index)
        {
            case 0:     // CLOCKWISE
                g_cur_rotation_settings = Rotation_Clockwise;
                break;
            case 1:     // ANTI_CLOCKWISE
                g_cur_rotation_settings = Rotation_Anti_Clockwise;
                break;
            default:
                ERRORPRINTF("Invalid index [%d]", index);
                break;
        }
    }
}

static void init_widgets_with_settings()
{
    LOGPRINTF(" init_widgets_with_settings "); 

    int i = 0;
    int to_be_activated = 0 ;

    if ( g_cur_rotation_settings == Rotation_Clockwise )
    {
        to_be_activated = 0; 
    } 
    else
    {
        to_be_activated = 1;
    }

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