~cairo-dock-team/cairo-dock-plug-ins/plug-ins

/**

* This file is a part of the Cairo-Dock project

*

* Copyright : (C) see the 'copyright' file.

* E-mail    : see the 'copyright' file.

*

* 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/>.

*/

 

#include "stdlib.h"

 

#include "applet-config.h"

#include "applet-notifications.h"

#include "applet-struct.h"

#include "applet-slider.h"

#include "applet-init.h"

 

 

CD_APPLET_DEFINITION (N_("slider"),

        2, 0, 0,

        CAIRO_DOCK_CATEGORY_APPLET_ACCESSORY,

        N_("This applet is a basic image slider\n"

        " You just have to select a directory and a display effect and you're done\n"

        "Click to play/pause or to edit the current image.\n"

        "Middle-click to open the images folder."),

        "ChAnGFu (Rémy Robertson) &amp; Fabounet (Fabrice Rey)")

 

//\___________ Here is where you initiate your applet. myConfig is already set at this point, and also myIcon, myContainer, myDock, myDesklet (and myDrawContext if you're in dock mode). The macro CD_APPLET_MY_CONF_FILE and CD_APPLET_MY_KEY_FILE can give you access to the applet's conf-file and its corresponding key-file (also available during reload). If you're in desklet mode, myDrawContext is still NULL, and myIcon's buffers has not been filled, because you may not need them then (idem when reloading).

CD_APPLET_INIT_BEGIN

        if (myDesklet) {

                CD_APPLET_SET_DESKLET_RENDERER ("Simple");

                CD_APPLET_ALLOW_NO_CLICKABLE_DESKLET;

        }

        

        CD_APPLET_GET_MY_ICON_EXTENT (&myData.iSurfaceWidth, &myData.iSurfaceHeight);

        

        cd_slider_start (myApplet, TRUE);  // TRUE <=> with delay

        

        CD_APPLET_REGISTER_FOR_CLICK_EVENT;

        CD_APPLET_REGISTER_FOR_BUILD_MENU_EVENT;

        CD_APPLET_REGISTER_FOR_MIDDLE_CLICK_EVENT;

        CD_APPLET_REGISTER_FOR_SCROLL_EVENT;

        CD_APPLET_REGISTER_FOR_UPDATE_ICON_EVENT;

CD_APPLET_INIT_END

 

 

//\___________ Here is where you stop your applet. myConfig and myData are still valid, but will be reseted to 0 at the end of the function. In the end, your applet will go back to its original state, as if it had never been activated.

CD_APPLET_STOP_BEGIN

        CD_APPLET_UNREGISTER_FOR_CLICK_EVENT;

        CD_APPLET_UNREGISTER_FOR_BUILD_MENU_EVENT;

        CD_APPLET_UNREGISTER_FOR_MIDDLE_CLICK_EVENT;

        CD_APPLET_UNREGISTER_FOR_SCROLL_EVENT;

        CD_APPLET_UNREGISTER_FOR_UPDATE_ICON_EVENT;

        

        cd_slider_stop (myApplet);

CD_APPLET_STOP_END

 

 

//\___________ The reload occurs in 2 occasions : when the user changes the applet's config, and when the user reload the cairo-dock's config or modify the desklet's size. The macro CD_APPLET_MY_CONFIG_CHANGED can tell you this. myConfig has already been reloaded at this point if you're in the first case, myData is untouched. You also have the macro CD_APPLET_MY_CONTAINER_TYPE_CHANGED that can tell you if you switched from dock/desklet to desklet/dock mode.

CD_APPLET_RELOAD_BEGIN

        CD_APPLET_GET_MY_ICON_EXTENT (&myData.iSurfaceWidth, &myData.iSurfaceHeight);  // meme si le container n'a pas change, car un desklet se redimensionne, et l'icone avec.

        

        //\_______________ Reload all changed data.

        if (CD_APPLET_MY_CONFIG_CHANGED)

        {

                if ((!myConfig.bImageName || myDock) && myIcon->cQuickInfo != NULL)  // remove quick-info if not displayed any more.

                {

                        CD_APPLET_SET_QUICK_INFO_ON_MY_ICON (NULL);

                }

                

                if (myDesklet && CD_APPLET_MY_CONTAINER_TYPE_CHANGED)  // we are now in a desklet, set a renderer.

                {

                        CD_APPLET_SET_DESKLET_RENDERER ("Simple");

                        CD_APPLET_ALLOW_NO_CLICKABLE_DESKLET;

                }

                

                if (cairo_dock_strings_differ (myData.cDirectory, myConfig.cDirectory)

                || myData.bSubDirs != myConfig.bSubDirs

                || myData.bRandom != myConfig.bRandom)  // need to reload the images list.

                {

                        cd_slider_stop (myApplet);

        

                        cd_slider_start (myApplet, FALSE);  // FALSE <=> immediately

                }

                else  // jump tp next slide to show the differences (new animation, new frame width, etc)

                {

                        cd_slider_jump_to_next_slide (myApplet);

                }

        }

        else

        {

                if (myData.pList)

                {

                        if (myData.pElement == NULL)

                                myData.pElement = myData.pList;

                        else

                                myData.pElement = cairo_dock_get_previous_element (myData.pElement, myData.pList);

                        cd_slider_jump_to_next_slide (myApplet);  // a quick'n'dirty but safe way to reload correctly the current image at the new applet's size.

                }

        }

CD_APPLET_RELOAD_END