tdebase
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

KonquerorIface.h 6.6KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
  1. /* This file is part of the KDE project
  2. Copyright (C) 2000 Simon Hausmann <hausmann@kde.org>
  3. Copyright (C) 2000 David Faure <faure@kde.org>
  4. This program is free software; you can redistribute it and/or
  5. modify it under the terms of the GNU General Public
  6. License as published by the Free Software Foundation; either
  7. version 2 of the License, or (at your option) any later version.
  8. This program is distributed in the hope that it will be useful,
  9. but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11. General Public License for more details.
  12. You should have received a copy of the GNU General Public License
  13. along with this program; see the file COPYING. If not, write to
  14. the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  15. Boston, MA 02110-1301, USA.
  16. */
  17. #ifndef __KonquerorIface_h__
  18. #define __KonquerorIface_h__
  19. #include <dcopobject.h>
  20. #include <tqvaluelist.h>
  21. #include <dcopref.h>
  22. #include <tqstringlist.h>
  23. /**
  24. * DCOP interface for konqueror
  25. */
  26. class KonquerorIface : virtual public DCOPObject
  27. {
  28. K_DCOP
  29. public:
  30. KonquerorIface();
  31. ~KonquerorIface();
  32. k_dcop:
  33. /**
  34. * Opens a new window for the given @p url (using createSimpleWindow, i.e. a single view)
  35. */
  36. DCOPRef openBrowserWindow( const TQString &url );
  37. /**
  38. * Like @ref openBrowserWindow , with setting the application startup notification ( ASN )
  39. * property on the window.
  40. */
  41. DCOPRef openBrowserWindowASN( const TQString &url, const TQCString &startup_id );
  42. /**
  43. * Opens a new window for the given @p url (using createNewWindow, i.e. with an appropriate profile)
  44. */
  45. DCOPRef createNewWindow( const TQString &url );
  46. /**
  47. * Like @ref createNewWindow , with setting the application startup notification ( ASN )
  48. * property on the window.
  49. */
  50. DCOPRef createNewWindowASN( const TQString &url, const TQCString &startup_id, bool tempFile );
  51. /**
  52. * Opens a new window like @ref createNewWindow, then selects the given @p filesToSelect
  53. */
  54. DCOPRef createNewWindowWithSelection( const TQString &url, TQStringList filesToSelect );
  55. /**
  56. * Like @ref createNewWindowWithSelection, with setting the application startup notification ( ASN )
  57. * property on the window.
  58. */
  59. DCOPRef createNewWindowWithSelectionASN( const TQString &url, TQStringList filesToSelect, const TQCString &startup_id );
  60. /**
  61. * Opens a new window for the given @p url (using createNewWindow, i.e. with an appropriate profile)
  62. * @param mimetype to speed it up.
  63. */
  64. DCOPRef createNewWindow( const TQString &url, const TQString & mimetype, bool tempFile );
  65. /**
  66. * Like @ref createNewWindow , with setting the application startup notification ( ASN )
  67. * property on the window.
  68. */
  69. DCOPRef createNewWindowASN( const TQString &url, const TQString & mimetype,
  70. const TQCString &startup_id, bool tempFile );
  71. /**
  72. * As the name says, this creates a window from a profile.
  73. * Used for instance by khelpcenter.
  74. */
  75. DCOPRef createBrowserWindowFromProfile( const TQString &path );
  76. /**
  77. * Like @ref createBrowserWindowFromProfile , with setting the application startup
  78. * notification ( ASN ) property on the window.
  79. */
  80. DCOPRef createBrowserWindowFromProfileASN( const TQString &path, const TQCString &startup_id );
  81. /**
  82. * As the name says, this creates a window from a profile.
  83. * Used for instance by kfmclient.
  84. * @param path full path to the profile file
  85. * @param filename name of the profile file, if under the profiles dir
  86. */
  87. DCOPRef createBrowserWindowFromProfile( const TQString &path, const TQString &filename );
  88. /**
  89. * Like @ref createBrowserWindowFromProfile , with setting the application startup
  90. * notification ( ASN ) property on the window.
  91. */
  92. DCOPRef createBrowserWindowFromProfileASN( const TQString &path, const TQString &filename,
  93. const TQCString &startup_id );
  94. /**
  95. * Creates a window from a profile and a URL.
  96. * Used by kfmclient to open http URLs with the webbrowsing profile
  97. * and others with the filemanagement profile.
  98. * @param path full path to the profile file
  99. * @param filename name of the profile file, if under the profiles dir
  100. * @param url the URL to open
  101. */
  102. DCOPRef createBrowserWindowFromProfileAndURL( const TQString &path, const TQString &filename, const TQString &url );
  103. /**
  104. * Like @ref createBrowserWindowFromProfileAndURL , with setting the application startup
  105. * notification ( ASN ) property on the window.
  106. */
  107. DCOPRef createBrowserWindowFromProfileAndURLASN( const TQString &path, const TQString &filename, const TQString &url,
  108. const TQCString &startup_id );
  109. /**
  110. * Creates a window the fastest way : the caller has to provide
  111. * profile, URL, and mimetype.
  112. * @param path full path to the profile file
  113. * @param filename name of the profile file, if under the profiles dir
  114. * @param url the URL to open
  115. * @param mimetype the mimetype that the URL we want to open has
  116. */
  117. DCOPRef createBrowserWindowFromProfileAndURL( const TQString &path, const TQString &filename, const TQString &url, const TQString &mimetype );
  118. /**
  119. * Like @ref createBrowserWindowFromProfileAndURL , with setting the application startup
  120. * notification ( ASN ) property on the window.
  121. */
  122. DCOPRef createBrowserWindowFromProfileAndURLASN( const TQString &path, const TQString &filename, const TQString &url, const TQString &mimetype,
  123. const TQCString& startup_id );
  124. /**
  125. * Called by kcontrol when the global configuration changes
  126. */
  127. ASYNC reparseConfiguration();
  128. /**
  129. * @return the name of the instance's crash log file
  130. */
  131. TQString crashLogFile();
  132. /**
  133. * @return a list of references to all the windows
  134. */
  135. TQValueList<DCOPRef> getWindows();
  136. /**
  137. * Called internally as broadcast when the user adds/removes/renames a view profile
  138. */
  139. ASYNC updateProfileList();
  140. /**
  141. * Called internally as broadcast when a URL is to be added to the combobox.
  142. */
  143. ASYNC addToCombo( TQString, TQCString );
  144. /**
  145. * Called internall as broadcast when a URL has to be removed from the combo.
  146. */
  147. ASYNC removeFromCombo( TQString, TQCString );
  148. /**
  149. * Called internally as a broadcast when the combobox was cleared.
  150. */
  151. ASYNC comboCleared( TQCString );
  152. /**
  153. * Used by kfmclient when the 'minimize memory usage' setting is set
  154. * to find out if this konqueror can be used.
  155. */
  156. bool processCanBeReused( int screen );
  157. /**
  158. * Called from konqy_preloader to terminate this Konqueror instance,
  159. * if it's in the preloaded mode, and there are too many preloaded Konqy's
  160. */
  161. ASYNC terminatePreloaded();
  162. };
  163. #endif