Added copyright lines for files I've edited this year.
[synfig.git] / synfig-studio / trunk / src / gtkmm / state_sketch.cpp
index f96e4c4..fce5564 100644 (file)
@@ -2,19 +2,21 @@
 /*!    \file state_sketch.cpp
 **     \brief Template File
 **
-**     $Id: state_sketch.cpp,v 1.1.1.1 2005/01/07 03:34:37 darco Exp $
+**     $Id$
 **
 **     \legal
-**     Copyright (c) 2002 Robert B. Quattlebaum Jr.
+**     Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
+**     Copyright (c) 2007, 2008 Chris Moore
 **
-**     This software and associated documentation
-**     are CONFIDENTIAL and PROPRIETARY property of
-**     the above-mentioned copyright holder.
+**     This package 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.
 **
-**     You may not copy, print, publish, or in any
-**     other way distribute this software without
-**     a prior written agreement with
-**     the copyright holder.
+**     This package 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.
 **     \endlegal
 */
 /* ========================================================================= */
@@ -59,6 +61,8 @@
 #include <gtkmm/checkbutton.h>
 #include <gtkmm/actiongroup.h>
 
+#include "general.h"
+
 #endif
 
 /* === U S I N G =========================================================== */
@@ -85,7 +89,7 @@ class studio::StateSketch_Context : public sigc::trackable
 
        bool prev_table_status;
        bool prev_workarea_layer_status_;
-       
+
        Gtk::Table options_table;
        Gtk::Button button_clear_sketch;
        Gtk::Button button_undo_stroke;
@@ -98,7 +102,7 @@ class studio::StateSketch_Context : public sigc::trackable
        void load_sketch();
        void undo_stroke();
        void toggle_show_sketch();
-       
+
 public:
 
        Smach::event_result event_stop_handler(const Smach::event& x);
@@ -124,7 +128,7 @@ public:
        synfig::Time get_time()const { return get_canvas_interface()->get_time(); }
        synfig::Canvas::Handle get_canvas()const{return canvas_view_->get_canvas();}
        WorkArea * get_work_area()const{return canvas_view_->get_work_area();}
-       
+
 };     // END of class StateSketch_Context
 
 
@@ -138,9 +142,9 @@ StateSketch::StateSketch():
        insert(event_def(EVENT_REFRESH_DUCKS,&StateSketch_Context::event_refresh_handler));
        insert(event_def(EVENT_WORKAREA_MOUSE_BUTTON_DOWN,&StateSketch_Context::event_mouse_down_handler));
        insert(event_def(EVENT_WORKAREA_STROKE,&StateSketch_Context::event_stroke));
-       insert(event_def(EVENT_REFRESH_TOOL_OPTIONS,&StateSketch_Context::event_refresh_tool_options)); 
-       insert(event_def(EVENT_YIELD_TOOL_OPTIONS,&StateSketch_Context::event_yield_tool_options));     
-}      
+       insert(event_def(EVENT_REFRESH_TOOL_OPTIONS,&StateSketch_Context::event_refresh_tool_options));
+       insert(event_def(EVENT_YIELD_TOOL_OPTIONS,&StateSketch_Context::event_yield_tool_options));
+}
 
 StateSketch::~StateSketch()
 {
@@ -150,8 +154,8 @@ void
 StateSketch_Context::save_sketch()
 {
        synfig::String filename(basename(get_canvas()->get_file_name())+".sketch");
-       
-       while(App::dialog_save_file(_("Save Sketch"), filename))
+
+       while(App::dialog_save_file(_("Save Sketch"), filename, SKETCH_DIR_PREFERENCE))
        {
                // If the filename still has wildcards, then we should
                // continue looking for the file we want
@@ -169,8 +173,8 @@ void
 StateSketch_Context::load_sketch()
 {
        synfig::String filename(basename(get_canvas()->get_file_name())+".sketch");
-       
-       while(App::dialog_open_file(_("Load Sketch"), filename))
+
+       while(App::dialog_open_file(_("Load Sketch"), filename, SKETCH_DIR_PREFERENCE))
        {
                // If the filename still has wildcards, then we should
                // continue looking for the file we want
@@ -188,24 +192,40 @@ StateSketch_Context::load_sketch()
 void
 StateSketch_Context::clear_sketch()
 {
-       get_work_area()->clear_persistant_strokes();
-       get_canvas_view()->get_smach().process_event(EVENT_REFRESH);
+       get_work_area()->clear_persistent_strokes();
+
+       // if the sketch is currently shown, make sure it is updated
+       //! \todo is there a better way than this of getting Duckmatic to update its stroke_list_?
+       if (checkbutton_show_sketch.get_active())
+       {
+               get_work_area()->set_show_persistent_strokes(false);
+               get_work_area()->set_show_persistent_strokes(true);
+               get_canvas_view()->get_smach().process_event(EVENT_REFRESH);
+       }
 }
 
 void
 StateSketch_Context::undo_stroke()
 {
-       if(!get_work_area()->persistant_stroke_list().empty())
+       if(!get_work_area()->persistent_stroke_list().empty())
        {
-               get_work_area()->persistant_stroke_list().pop_back();
-               get_canvas_view()->get_smach().process_event(EVENT_REFRESH);
+               get_work_area()->persistent_stroke_list().pop_back();
+
+               // if the sketch is currently shown, make sure it is updated
+               //! \todo is there a better way than this of getting Duckmatic to update its stroke_list_?
+               if (checkbutton_show_sketch.get_active())
+               {
+                       get_work_area()->set_show_persistent_strokes(false);
+                       get_work_area()->set_show_persistent_strokes(true);
+                       get_canvas_view()->get_smach().process_event(EVENT_REFRESH);
+               }
        }
 }
 
 void
 StateSketch_Context::toggle_show_sketch()
 {
-       get_work_area()->set_show_persistant_strokes(checkbutton_show_sketch.get_active());
+       get_work_area()->set_show_persistent_strokes(checkbutton_show_sketch.get_active());
        get_work_area()->queue_draw();
 }
 
@@ -213,7 +233,7 @@ StateSketch_Context::StateSketch_Context(CanvasView* canvas_view):
        action_group(Gtk::ActionGroup::create()),
        canvas_view_(canvas_view),
        is_working(*canvas_view),
-       prev_workarea_layer_status_(get_work_area()->allow_layer_clicks),
+       prev_workarea_layer_status_(get_work_area()->get_allow_layer_clicks()),
        button_clear_sketch(_("Clear Sketch")),
        button_undo_stroke(_("Undo Stroke")),
        button_save_sketch(_("Save Sketch")),
@@ -295,47 +315,47 @@ StateSketch_Context::StateSketch_Context(CanvasView* canvas_view):
 
        App::ui_manager()->add_ui_from_string(ui_info);
 
-       
-       checkbutton_show_sketch.set_active(get_work_area()->get_show_persistant_strokes());
-       
+
+       checkbutton_show_sketch.set_active(get_work_area()->get_show_persistent_strokes());
+
        button_clear_sketch.signal_clicked().connect(sigc::mem_fun(*this,&studio::StateSketch_Context::clear_sketch));
        button_undo_stroke.signal_clicked().connect(sigc::mem_fun(*this,&studio::StateSketch_Context::undo_stroke));
        button_save_sketch.signal_clicked().connect(sigc::mem_fun(*this,&studio::StateSketch_Context::save_sketch));
        button_load_sketch.signal_clicked().connect(sigc::mem_fun(*this,&studio::StateSketch_Context::load_sketch));
        checkbutton_show_sketch.signal_clicked().connect(sigc::mem_fun(*this,&studio::StateSketch_Context::toggle_show_sketch));
-       //options_table.attach(*manage(new Gtk::Label(_("Sketch Tool"))), 0, 2, 0, 1, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);      
-       options_table.attach(checkbutton_show_sketch, 0, 2, 1, 2, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);  
-       //options_table.attach(button_undo_stroke, 0, 2, 2, 3, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);     
-       //options_table.attach(button_clear_sketch, 0, 2, 3, 4, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);    
-       //options_table.attach(button_save_sketch, 0, 1, 4, 5, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);     
-       //options_table.attach(button_load_sketch, 1, 2, 4, 5, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);     
-
-       
+       //options_table.attach(*manage(new Gtk::Label(_("Sketch Tool"))), 0, 2, 0, 1, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);
+       options_table.attach(checkbutton_show_sketch, 0, 2, 1, 2, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);
+       //options_table.attach(button_undo_stroke, 0, 2, 2, 3, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);
+       //options_table.attach(button_clear_sketch, 0, 2, 3, 4, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);
+       //options_table.attach(button_save_sketch, 0, 1, 4, 5, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);
+       //options_table.attach(button_load_sketch, 1, 2, 4, 5, Gtk::EXPAND|Gtk::FILL, Gtk::EXPAND|Gtk::FILL, 0, 0);
+
+
        options_table.show_all();
        refresh_tool_options();
        App::dialog_tool_options->present();
-       
+
        // Turn off layer clicking
-       get_work_area()->allow_layer_clicks=false;
+       get_work_area()->set_allow_layer_clicks(false);
 
        get_canvas_view()->work_area->set_cursor(Gdk::PENCIL);
 
        // Turn off duck clicking
-       get_work_area()->allow_duck_clicks=false;
-       
+       get_work_area()->set_allow_duck_clicks(false);
+
        // clear out the ducks
        //get_work_area()->clear_ducks();
-       
+
        // Refresh the work area
        //get_work_area()->queue_draw();
-       
+
        // Hide the tables if they are showing
        prev_table_status=get_canvas_view()->tables_are_visible();
        //if(prev_table_status)get_canvas_view()->hide_tables();
-               
-       // Hide the time bar
-       //get_canvas_view()->hide_timebar();
-       
+
+       // Disable the time bar
+       //get_canvas_view()->set_sensitive_timebar(false);
+
        // Connect a signal
        //get_work_area()->signal_user_click().connect(sigc::mem_fun(*this,&studio::StateSketch_Context::on_user_click));
 
@@ -347,20 +367,19 @@ StateSketch_Context::~StateSketch_Context()
        get_canvas_view()->work_area->reset_cursor();
 
        App::dialog_tool_options->clear();
-       
+
        // Restore layer clicking
-       get_work_area()->allow_layer_clicks=prev_workarea_layer_status_;
+       get_work_area()->set_allow_layer_clicks(prev_workarea_layer_status_);
 
        // Restore duck clicking
-       get_work_area()->allow_duck_clicks=true;
+       get_work_area()->set_allow_duck_clicks(true);
 
-       // Show the time bar
-       if(get_canvas_view()->get_canvas()->rend_desc().get_time_start()!=get_canvas_view()->get_canvas()->rend_desc().get_time_end())
-               get_canvas_view()->show_timebar();
+       // Enable the time bar
+       //get_canvas_view()->set_sensitive_timebar(true);
 
        // Bring back the tables if they were out before
        if(prev_table_status)get_canvas_view()->show_tables();
-                       
+
        // Refresh the work area
        //get_work_area()->queue_draw();
 
@@ -383,7 +402,7 @@ StateSketch_Context::refresh_tool_options()
        App::dialog_tool_options->set_name("sketch");
 
        App::ui_manager()->insert_action_group(action_group);
-       App::dialog_tool_options->set_toolbar(*dynamic_cast<Gtk::Toolbar*>(App::ui_manager()->get_widget("/toolbar-sketch")));  
+       App::dialog_tool_options->set_toolbar(*dynamic_cast<Gtk::Toolbar*>(App::ui_manager()->get_widget("/toolbar-sketch")));
 
        /*
        App::dialog_tool_options->add_button(
@@ -432,27 +451,27 @@ StateSketch_Context::refresh_tool_options()
 }
 
 Smach::event_result
-StateSketch_Context::event_refresh_tool_options(const Smach::event& x)
+StateSketch_Context::event_refresh_tool_options(const Smach::event& /*x*/)
 {
        refresh_tool_options();
        return Smach::RESULT_ACCEPT;
 }
 
 Smach::event_result
-StateSketch_Context::event_yield_tool_options(const Smach::event& x)
+StateSketch_Context::event_yield_tool_options(const Smach::event& /*x*/)
 {
        yield_tool_options();
        return Smach::RESULT_ACCEPT;
 }
 
 Smach::event_result
-StateSketch_Context::event_stop_handler(const Smach::event& x)
+StateSketch_Context::event_stop_handler(const Smach::event& /*x*/)
 {
        throw Smach::egress_exception();
 }
 
 Smach::event_result
-StateSketch_Context::event_refresh_handler(const Smach::event& x)
+StateSketch_Context::event_refresh_handler(const Smach::event& /*x*/)
 {
        return Smach::RESULT_ACCEPT;
 }
@@ -469,11 +488,12 @@ StateSketch_Context::event_mouse_down_handler(const Smach::event& x)
                        get_canvas_view()->get_smach().push_state(&state_stroke);
                        return Smach::RESULT_ACCEPT;
                }
-       
-       case BUTTON_RIGHT: // Intercept the right-button click to short-circut the pop-up menu
-               return Smach::RESULT_ACCEPT;
-       
-       default:        
+
+       case BUTTON_RIGHT: // Intercept the right-button click to short-circuit the pop-up menu
+               if (!getenv("SYNFIG_ENABLE_POPUP_MENU_IN_ALL_TOOLS"))
+                       return Smach::RESULT_ACCEPT;
+
+       default:
                return Smach::RESULT_OK;
        }
 }
@@ -484,8 +504,8 @@ StateSketch_Context::event_stroke(const Smach::event& x)
        const EventStroke& event(*reinterpret_cast<const EventStroke*>(&x));
 
        assert(event.stroke_data);
-               
-       get_work_area()->add_persistant_stroke(event.stroke_data,synfigapp::Main::get_foreground_color());
+
+       get_work_area()->add_persistent_stroke(event.stroke_data,synfigapp::Main::get_foreground_color());
 
        return Smach::RESULT_ACCEPT;
 }