[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-frameworks-devel
Subject:    Re: Review Request 125817: Add plugin system for Calendar events
From:       "Martin Klapetek" <martin.klapetek () gmail ! com>
Date:       2015-11-16 16:55:21
Message-ID: 20151116165521.14400.62301 () mimi ! kde ! org
[Download RAW message or body]

--===============4898554316343908881==
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 8bit


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/125817/
-----------------------------------------------------------

(Updated Nov. 16, 2015, 4:55 p.m.)


Status
------

This change has been marked as submitted.


Review request for KDE Frameworks, Plasma and Daniel Vrátil.


Changes
-------

Submitted with commit fe0384f0d4152e622b203385bd968657a3650d2c by Martin Klapetek to \
branch master.


Repository: plasma-framework


Description
-------

This adds a simple plugin interface that can be subclassed
and provide events integration with Plasma Calendar applet.

It's asynchronous and I've kept it deliberately simple.
For now the Calendar tells the plugins which date range
is being displayed, the plugins load the data and then
emit the dataReady() signal containing the events.

The events are stored in a multihash for quick access
by the Calendar's agenda part but also for overall
easy-to-use (eg. in teh model data()).

The event data is stored in EventData class, which has
a pretty self-explanatory members, except perhaps the
"isMinor" one. The intention with this is to support
namedays, where in some countries the calendars have
different name every day. This is just a minor holiday
and as such should not mark the calendar grid, otherwise
the whole grid would be in a different color.

Putting the interface here might raise the question of
depending on plasma-framework, but plugins provided by
KDE can go to plasma-workspace and other 3rd party ones
would just have to live with it. I don't think it will
be a problem but if it turns out it is, we can rethink
the placement.


Diffs
-----

  src/declarativeimports/calendar/CMakeLists.txt 40ead91 
  src/declarativeimports/calendar/calendarplugin.cpp bafe80c 
  src/declarativeimports/calendar/daysmodel.h a5bdac9 
  src/declarativeimports/calendar/daysmodel.cpp 2d059a8 
  src/declarativeimports/calendar/eventdatadecorator.h PRE-CREATION 
  src/declarativeimports/calendar/eventdatadecorator.cpp PRE-CREATION 
  src/declarativeimports/calendar/plasmacalendarintegration/CMakeLists.txt \
PRE-CREATION   src/declarativeimports/calendar/plasmacalendarintegration/PlasmaCalendarIntegrationConfig.cmake.in \
PRE-CREATION   src/declarativeimports/calendar/plasmacalendarintegration/calendareventsplugin.h \
PRE-CREATION   src/declarativeimports/calendar/plasmacalendarintegration/calendareventsplugin.cpp \
PRE-CREATION   src/declarativeimports/calendar/plasmacalendarintegration/eventdata_p.cpp \
PRE-CREATION   src/declarativeimports/calendar/plasmacalendarintegration/plasmacalendarintegration_export.h \
PRE-CREATION 

Diff: https://git.reviewboard.kde.org/r/125817/diff/


Testing
-------

I have a simple KHolidays based plugin written (patch should be up later today)
and patches in the Calendar applet.

Everything works as expected:
* the days are marked as containing an event
* the agenda part displays details of that event (name)


Thanks,

Martin Klapetek


--===============4898554316343908881==
MIME-Version: 1.0
Content-Type: text/html; charset="utf-8"
Content-Transfer-Encoding: 8bit




<html>
 <body>
  <div style="font-family: Verdana, Arial, Helvetica, Sans-Serif;">
   <table bgcolor="#f9f3c9" width="100%" cellpadding="12" style="border: 1px #c9c399 \
solid; border-radius: 6px; -moz-border-radius: 6px; -webkit-border-radius: 6px;">  \
<tr>  <td>
      This is an automatically generated e-mail. To reply, visit:
      <a href="https://git.reviewboard.kde.org/r/125817/">https://git.reviewboard.kde.org/r/125817/</a>
  </td>
    </tr>
   </table>
   <br />



<table bgcolor="#e0e0e0" width="100%" cellpadding="12" style="border: 1px gray solid; \
border-radius: 6px; -moz-border-radius: 6px; -webkit-border-radius: 6px;">  <tr>
  <td>
   <h1 style="margin: 0; padding: 0; font-size: 10pt;">This change has been marked as \
submitted.</h1>  </td>
 </tr>
</table>
<br />


<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="12" style="border: \
1px #888a85 solid; border-radius: 6px; -moz-border-radius: 6px; \
-webkit-border-radius: 6px;">  <tr>
  <td>

<div>Review request for KDE Frameworks, Plasma and Daniel Vrátil.</div>
<div>By Martin Klapetek.</div>


<p style="color: grey;"><i>Updated Nov. 16, 2015, 4:55 p.m.</i></p>



<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Changes</h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" style="border: \
1px solid #b8b5a0">  <tr>
  <td>
   <pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;">Submitted with commit fe0384f0d4152e622b203385bd968657a3650d2c by Martin \
Klapetek to branch master.</pre>  </td>
 </tr>
</table>







<div style="margin-top: 1.5em;">
 <b style="color: #575012; font-size: 10pt;">Repository: </b>
plasma-framework
</div>


<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Description </h1>
 <table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" \
style="border: 1px solid #b8b5a0">  <tr>
  <td>
   <pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;"><p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">This adds a simple plugin interface that can be \
subclassed and provide events integration with Plasma Calendar applet.</p>
<p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">It's asynchronous and I've kept it deliberately \
simple. For now the Calendar tells the plugins which date range
is being displayed, the plugins load the data and then
emit the dataReady() signal containing the events.</p>
<p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">The events are stored in a multihash for quick access \
by the Calendar's agenda part but also for overall easy-to-use (eg. in teh model \
data()).</p> <p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">The event data is stored in EventData class, which has \
a pretty self-explanatory members, except perhaps the "isMinor" one. The intention \
with this is to support namedays, where in some countries the calendars have
different name every day. This is just a minor holiday
and as such should not mark the calendar grid, otherwise
the whole grid would be in a different color.</p>
<p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">Putting the interface here might raise the question of \
depending on plasma-framework, but plugins provided by KDE can go to plasma-workspace \
and other 3rd party ones would just have to live with it. I don't think it will
be a problem but if it turns out it is, we can rethink
the placement.</p></pre>
  </td>
 </tr>
</table>


<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Testing </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" style="border: \
1px solid #b8b5a0">  <tr>
  <td>
   <pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;">I have a simple KHolidays based plugin written (patch should be up later \
today) and patches in the Calendar applet.

Everything works as expected:
* the days are marked as containing an event
* the agenda part displays details of that event (name)</pre>
  </td>
 </tr>
</table>


<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Diffs</b> </h1>
<ul style="margin-left: 3em; padding-left: 0;">

 <li>src/declarativeimports/calendar/CMakeLists.txt <span style="color: \
grey">(40ead91)</span></li>

 <li>src/declarativeimports/calendar/calendarplugin.cpp <span style="color: \
grey">(bafe80c)</span></li>

 <li>src/declarativeimports/calendar/daysmodel.h <span style="color: \
grey">(a5bdac9)</span></li>

 <li>src/declarativeimports/calendar/daysmodel.cpp <span style="color: \
grey">(2d059a8)</span></li>

 <li>src/declarativeimports/calendar/eventdatadecorator.h <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/declarativeimports/calendar/eventdatadecorator.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/declarativeimports/calendar/plasmacalendarintegration/CMakeLists.txt <span \
style="color: grey">(PRE-CREATION)</span></li>

 <li>src/declarativeimports/calendar/plasmacalendarintegration/PlasmaCalendarIntegrationConfig.cmake.in \
<span style="color: grey">(PRE-CREATION)</span></li>

 <li>src/declarativeimports/calendar/plasmacalendarintegration/calendareventsplugin.h \
<span style="color: grey">(PRE-CREATION)</span></li>

 <li>src/declarativeimports/calendar/plasmacalendarintegration/calendareventsplugin.cpp \
<span style="color: grey">(PRE-CREATION)</span></li>

 <li>src/declarativeimports/calendar/plasmacalendarintegration/eventdata_p.cpp <span \
style="color: grey">(PRE-CREATION)</span></li>

 <li>src/declarativeimports/calendar/plasmacalendarintegration/plasmacalendarintegration_export.h \
<span style="color: grey">(PRE-CREATION)</span></li>

</ul>

<p><a href="https://git.reviewboard.kde.org/r/125817/diff/" style="margin-left: \
3em;">View Diff</a></p>






  </td>
 </tr>
</table>



  </div>
 </body>
</html>


--===============4898554316343908881==--


[Attachment #3 (text/plain)]

_______________________________________________
Kde-frameworks-devel mailing list
Kde-frameworks-devel@kde.org
https://mail.kde.org/mailman/listinfo/kde-frameworks-devel


[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic