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

List:       kde-commits
Subject:    branches/kolourpaint/control/devel-doc/code-walk-thru
From:       Clarence Dang <dang () kde ! org>
Date:       2007-10-26 18:46:09
Message-ID: 1193424369.563095.28611.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 729724 by dang:

more sugar


 M  +28 -5     layers/layers.txt  
 M  +6 -6      licensing.txt  
 M  +49 -28    resources.txt  
 M  +4 -2      style.txt  
 M  +3 -3      tools/tools.txt  


--- branches/kolourpaint/control/devel-doc/code-walk-thru/layers/layers.txt #729723:729724
@@ -296,13 +296,14 @@
 .................
 
 When the user drags to create a text box, it is, like with image
-selections, just a border.
+selections, just a border -- it has no text lines.
 
 Before modifying the text box (e.g. adding text or drag-moving the text
-box), you must give the text box "content" (i.e. mark it as editable / make
-it a "floating" selection) using kpToolTextGiveContentCommand.  This is unlike
-KolourPaint/KDE3, where merely dragging to create a text box added a command
-to the command history and the box was editable immediately.
+box), you must give the text box "content" (i.e. give it 1 empty text
+line and making it a "floating" selection) using
+kpToolTextGiveContentCommand.  This is unlike KolourPaint/KDE3, where merely
+dragging to create a text box added a command to the command history and the
+box was editable immediately.
 
 *** The above "giving of content" is mandatory before manipulating a
     text selection. ***
@@ -372,3 +373,25 @@
 _must_ still be recorded as a command -- see
 kpAbstractImageSelectionTool::changeImageSelectionTransparency() for a
 discussion.
+
+Another tricky situation is where the user tries to mislead
+KolourPaint e.g.:
+
+  1. Drag out a rectangular border.
+
+  2. Drag-move the selection, which adds to the command history:
+     a) kpToolSelectionCreateCommand
+     b) kpMacroCommand consisting of kpToolSelectionPullFromDocumentCommand
+        and kpToolSelectionMoveCommand
+
+  3. Undo.  This puts us in the state after 2.a)., with our rectangular
+     border created by 1.
+
+  4. The user deliberately drags out a rectangular border elsewhere.
+     This does not change the command history since we only replaced a border,
+     not a floating selection (if it was a floating selection,
+     kpToolSelectionDestroyCommand would have been added to the command
+     history).
+
+  5. Redo.  2.b) is executed, but given a different border to when it was
+     constructed.  Thankfully, we handle that by ignoring the new border.
--- branches/kolourpaint/control/devel-doc/code-walk-thru/licensing.txt #729723:729724
@@ -5,12 +5,12 @@
 usable by anyone, for anything.  This includes closed-source derivatives
 but actually, the main motivations are to allow:
 
-1.Moving of generic code into an LGPL library (you cannot do this with the
-GPL if the copyright is diluted and those other copyright holders disappear
-or stubbornly refuse to relicense)
+1. Moving of generic code into an LGPL library (you cannot do this with the
+   GPL if the copyright is diluted and those other copyright holders disappear
+   or stubbornly refuse to relicense)
 
-2.Reuse of the code in BSD projects, that don't agree with GPL licensing
-(which might be due to either die-hard philosophy and/or Reason 1).
+2. Reuse of the code in BSD projects, that don't agree with GPL licensing
+   (which might be due to either die-hard philosophy and/or Reason 1).
 
 The great thing about the BSD license is that if you don't agree with it,
 you can make a fork under the GPL license.  In contrast, if you license
@@ -29,7 +29,7 @@
 be done with caution and probably only works with GPLv2.
 
 Contrary to popular belief, the GPL does not prevent closed-source
-derivatives from being created as long as there is only one copyright
+derivatives from being created -- as long as there is only one copyright
 holder or all copyright holders conspire together.
 
 
--- branches/kolourpaint/control/devel-doc/code-walk-thru/resources.txt #729723:729724
@@ -1,8 +1,22 @@
 
+Project Resources
 
-Source Repository
-~~~~~~~~~~~~~~~~~
 
+1. Source Repository
+2. Coverity
+3. English Breakfast Network (EBN)
+4. Sourceforge
+5. Website
+6. Mailinglists
+7. http://bugs.kde.org
+8. Other Websites
+9. Domain Name
+10. Artists
+
+
+1. Source Repository
+~~~~~~~~~~~~~~~~~~~~
+
 Initial versions held on Clarence Dang's hard disk.
 
 After a while, this was moved into KDE CVS.
@@ -14,17 +28,22 @@
 code information
 
 trunk/KDE/kdegraphics/{doc/,}kolourpaint – current development branch for
-KDE 4, for all future feature development.  On top of the normal kdelibs
-dependency, you need qimageblitz.
+KDE 4, for all future feature development.
 
+On top of the normal kdelibs dependency, you need qimageblitz.
+
 Essentially, this is a port of KDE 3.5's KolourPaint to KDE 4 plus
 heavy refactoring and a few new features.  All regressions due to the
 port have been marked in the source code with "COMPAT".
 
 It contains all fixes and features in KDE 3.5.8's KolourPaint.
 
+You should backport all changes to the KDE 3.5 branch.
+
 branches/KDE/3.5/kdegraphics/{doc/,}kolourpaint – backport branch for KDE 3
 
+You should forward port all changes to trunk/.
+
 branches/KDE/3.4/kdegraphics/{doc/,}kolourpaint – dead backport branch
 
 branches/KDE/3.3/kdegraphics/{doc/,}kolourpaint – dead backport branch
@@ -36,8 +55,8 @@
 branches/kolourpaint/1.0/ - dead, standalone release branch for KDE 3.0
 
 
-Coverity
-~~~~~~~~
+2. Coverity
+~~~~~~~~~~~
 
 Coverity [http://www.coverity.com/] is a commercial and expensive static
 source analyser that finds bugs and false positives.  They do free scans of
@@ -45,8 +64,8 @@
 the scans.  Many KDE developers have Coverity accounts.
 
 
-English Breakfast Network (EBN)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+3. English Breakfast Network (EBN)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 A KDE static source analyser [http://www.englishbreakfastnetwork.org/]
 like Coverity.
@@ -54,15 +73,15 @@
 Checks .docbook User Documentation and code for all KDE branches.
 
 
-Sourceforge
-~~~~~~~~~~~
+4. Sourceforge
+~~~~~~~~~~~~~~
 
 http://sourceforge.net/projects/kolourpaint/ is the Sourceforge project.
-The admin,  Clarence Dang can give you access to this.
+The admin, Clarence Dang, can give you access to this.
 
 
-Website
-~~~~~~~
+5. Website
+~~~~~~~~~~
 
 The website is http://kolourpaint.sourceforge.net/.  You need a Sourceforge
 account to modify the webpage via SSH at
@@ -77,12 +96,12 @@
 interested  web developer.
 
 
-Mailinglists
-~~~~~~~~~~~~
+6. Mailinglists
+~~~~~~~~~~~~~~~
 
 The mailing lists hosted on sourceforge are practically dead.
 
-<kolourpaint-support AT lists.sourceforge.net> is a support address but
+<kolourpaint-support AT lists.sourceforge.net> is a live support address but
 receives huge amounts of spam.  One implemented measure to reduce spam has
 been to configure mailman to stop replying to spammers with:
 
@@ -103,25 +122,27 @@
 ~~~~
 
 
-http://bugs.kde.org
-~~~~~~~~~~~~~~~~~~~
+7. http://bugs.kde.org
+~~~~~~~~~~~~~~~~~~~~~~
 
 Some bugs are listed in the "BUGS" and "TODO" files, or marked in the
 source code.  Others are listed there.
 
 Bugs owned by "kolourpaint-support@lists.sourceforge.net" are KolourPaint
-bugs.  Bugs of which that address is CC'ed are not directly KolourPaint
-bugs but are interesting for KolourPaint.
+bugs.  The neat thing about this is that if you are sitting behind
+kolourpaint-support, you also get bug report emails from
+http://bugs.kde.org.  Bugs of which that address is CC'ed are not directly
+KolourPaint bugs but are interesting for KolourPaint.
 
 
-Other websites
-~~~~~~~~~~~~~
+8. Other Websites
+~~~~~~~~~~~~~~~~~
 
 There's a KolourPaint page at freshmeat.net and kde-apps.org.
 
 
-Domain Name
-~~~~~~~~~~~
+9. Domain Name
+~~~~~~~~~~~~~~
 
 http://www.kolourpaint.org/ is currently a Namesecure domain that redirects
 to http://kolourpaint.sourceforge.net/.  The registrant is Clarence Dang,
@@ -133,12 +154,12 @@
 while .org and .com are very ordinary.
 
 
-Artists
-~~~~~~~
+10. Artists
+~~~~~~~~~~~
 
 If you need more icons drawn, try:
 
-1. Reuse a standard KDE icon.
+1. Reusing a standard KDE icon.
 2. The existing artists for KolourPaint's icons.
 3. http://www.kde-artists.org/ might be able to help.
-4. Find an artist community on the internet.
\ No newline at end of file
+4. Find an artist community on the internet.
--- branches/kolourpaint/control/devel-doc/code-walk-thru/style.txt #729723:729724
@@ -43,9 +43,11 @@
 
 
 Also, before every method, put:
-// {public, private, protected} {static,
-// {overrides, virtual} {[base sclass],}}
+// {public, private, protected} {slot, }  \
+// {static, {overrides, virtual} {[base sclass],}, }
 
+e.g. // protected slot virtual [base kpTool]
+
 overrides = non-virtual override (a method with the same name, which
             usually calls the method being overridden)
 
--- branches/kolourpaint/control/devel-doc/code-walk-thru/tools/tools.txt #729723:729724
@@ -7,7 +7,7 @@
 1.2. Tracking UI Changes
 1.3. Status Bar
 
-2. Classs Overview
+2. Class Overview
 2.1. tools/
 2.2. tools/flow/
 2.3. tools/polygonal/
@@ -173,8 +173,8 @@
 actually a legal size for northwest mouse drag (-1x-1).
 
 
-2. Classs Overview
-~~~~~~~~~~~~~~~~~~
+2. Class Overview
+~~~~~~~~~~~~~~~~~
 
 2.1. tools/
 -----------
[prev in list] [next in list] [prev in thread] [next in thread]