ginebra2/ginebra.dox
author hgs
Fri, 06 Aug 2010 17:23:08 -0400
changeset 9 b39122337a00
parent 3 0954f5dd2cd0
child 12 afcd8e6d025b
permissions -rw-r--r--
201031
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3
hgs
parents:
diff changeset
     1
// This file contains additional documentation for classes defined 
hgs
parents:
diff changeset
     2
// in common code.  It can be used to describe how those classes 
hgs
parents:
diff changeset
     3
// are used by Ginebra.
hgs
parents:
diff changeset
     4
hgs
parents:
diff changeset
     5
  /*! \ingroup JavascriptAPI
hgs
parents:
diff changeset
     6
   * \class WebPageController
hgs
parents:
diff changeset
     7
   *
hgs
parents:
diff changeset
     8
   * Javascript object name: "pageController"
hgs
parents:
diff changeset
     9
   * Example javascript code to connect to the page controller's pageLoadStarted signal and print
hgs
parents:
diff changeset
    10
   * the current URL to debug output.
hgs
parents:
diff changeset
    11
   * \code
hgs
parents:
diff changeset
    12
   * window.pageController.pageLoadStarted.connect(
hgs
parents:
diff changeset
    13
   *   function() {
hgs
parents:
diff changeset
    14
   *        app.debug("Load start" + window.pageController.currentRequestedUrl);
hgs
parents:
diff changeset
    15
   *   }
hgs
parents:
diff changeset
    16
   * );
hgs
parents:
diff changeset
    17
   * \endcode
hgs
parents:
diff changeset
    18
   */
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
  /*! \ingroup JavascriptAPI
hgs
parents:
diff changeset
    21
   * \class WRT::BookmarksManager
hgs
parents:
diff changeset
    22
   *
hgs
parents:
diff changeset
    23
   * Javascript object name: "bookmarksManager"
hgs
parents:
diff changeset
    24
   * Example javascript code to get bookmarks data in JSON format.
hgs
parents:
diff changeset
    25
   * \code
hgs
parents:
diff changeset
    26
   * var bookmarkData = bookmarksManager.getBookmarksJSON();
hgs
parents:
diff changeset
    27
   * \endcode
hgs
parents:
diff changeset
    28
   */
hgs
parents:
diff changeset
    29
     
hgs
parents:
diff changeset
    30
  /*! \ingroup JavascriptAPI
hgs
parents:
diff changeset
    31
   * \class ViewEventContext
hgs
parents:
diff changeset
    32
   */
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
/*! \ingroup JavascriptAPI
hgs
parents:
diff changeset
    35
 * \brief Javascript wrapper for QActions.
hgs
parents:
diff changeset
    36
 */