cefpython/src/include/cef_context_menu_handler.h at cefpython56 · lineCode/cefpython · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

// Redistribution and use in source and binary forms, with or without

// modification, are permitted provided that the following conditions are

// met:

// * Redistributions of source code must retain the above copyright

// notice, this list of conditions and the following disclaimer.

// * Redistributions in binary form must reproduce the above

// copyright notice, this list of conditions and the following disclaimer

// in the documentation and/or other materials provided with the

// distribution.

// * Neither the name of Google Inc. nor the name Chromium Embedded

// Framework nor the names of its contributors may be used to endorse

// or promote products derived from this software without specific prior

// written permission.

// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

// ---------------------------------------------------------------------------

// The contents of this file must follow a specific format in order to

// support the CEF translator tool. See the translator.README.txt file in the

// tools directory for more information.

#ifndef CEF_INCLUDE_CEF_CONTEXT_MENU_HANDLER_H_

#define CEF_INCLUDE_CEF_CONTEXT_MENU_HANDLER_H_

#pragma once

#include "include/cef_base.h"

#include "include/cef_browser.h"

#include "include/cef_frame.h"

#include "include/cef_menu_model.h"

class CefContextMenuParams;

///

// Callback interface used for continuation of custom context menu display.

///

/*--cef(source=library)--*/

class CefRunContextMenuCallback : public virtual CefBase {

public:

typedef cef_event_flags_t EventFlags;

///

// Complete context menu display by selecting the specified |command_id| and

// |event_flags|.

///

/*--cef(capi_name=cont)--*/

virtual void Continue(int command_id, EventFlags event_flags) =0;

///

// Cancel context menu display.

///

/*--cef()--*/

virtual void Cancel() =0;

};

///

// Implement this interface to handle context menu events. The methods of this

// class will be called on the UI thread.

///

/*--cef(source=client)--*/

class CefContextMenuHandler : public virtual CefBase {

public:

typedef cef_event_flags_t EventFlags;

///

// Called before a context menu is displayed. |params| provides information

// about the context menu state. |model| initially contains the default

// context menu. The |model| can be cleared to show no context menu or

// modified to show a custom menu. Do not keep references to |params| or

// |model| outside of this callback.

///

/*--cef()--*/

virtual void OnBeforeContextMenu(CefRefPtr<CefBrowser> browser,

CefRefPtr<CefFrame> frame,

CefRefPtr<CefContextMenuParams> params,

CefRefPtr<CefMenuModel> model) {}

///

// Called to allow custom display of the context menu. |params| provides

// information about the context menu state. |model| contains the context menu

// model resulting from OnBeforeContextMenu. For custom display return true

// and execute |callback| either synchronously or asynchronously with the

// selected command ID. For default display return false. Do not keep

// references to |params| or |model| outside of this callback.

///

/*--cef()--*/

virtual bool RunContextMenu(CefRefPtr<CefBrowser> browser,

CefRefPtr<CefFrame> frame,

CefRefPtr<CefContextMenuParams> params,

CefRefPtr<CefMenuModel> model,

CefRefPtr<CefRunContextMenuCallback> callback) {

return false;

}

///

// Called to execute a command selected from the context menu. Return true if

// the command was handled or false for the default implementation. See

// cef_menu_id_t for the command ids that have default implementations. All

// user-defined command ids should be between MENU_ID_USER_FIRST and

// MENU_ID_USER_LAST. |params| will have the same values as what was passed to

// OnBeforeContextMenu(). Do not keep a reference to |params| outside of this

// callback.

///

/*--cef()--*/

virtual bool OnContextMenuCommand(CefRefPtr<CefBrowser> browser,

CefRefPtr<CefFrame> frame,

CefRefPtr<CefContextMenuParams> params,

int command_id,

EventFlags event_flags) { return false; }

///

// Called when the context menu is dismissed irregardless of whether the menu

// was empty or a command was selected.

///

/*--cef()--*/

virtual void OnContextMenuDismissed(CefRefPtr<CefBrowser> browser,

CefRefPtr<CefFrame> frame) {}

};

///

// Provides information about the context menu state. The ethods of this class

// can only be accessed on browser process the UI thread.

///

/*--cef(source=library)--*/

class CefContextMenuParams : public virtual CefBase {

public:

typedef cef_context_menu_type_flags_t TypeFlags;

typedef cef_context_menu_media_type_t MediaType;

typedef cef_context_menu_media_state_flags_t MediaStateFlags;

typedef cef_context_menu_edit_state_flags_t EditStateFlags;

///

// Returns the X coordinate of the mouse where the context menu was invoked.

// Coords are relative to the associated RenderView's origin.

///

/*--cef()--*/

virtual int GetXCoord() =0;

///

// Returns the Y coordinate of the mouse where the context menu was invoked.

// Coords are relative to the associated RenderView's origin.

///

/*--cef()--*/

virtual int GetYCoord() =0;

///

// Returns flags representing the type of node that the context menu was

// invoked on.

///

/*--cef(default_retval=CM_TYPEFLAG_NONE)--*/

virtual TypeFlags GetTypeFlags() =0;

///

// Returns the URL of the link, if any, that encloses the node that the

// context menu was invoked on.

///

/*--cef()--*/

virtual CefString GetLinkUrl() =0;

///

// Returns the link URL, if any, to be used ONLY for "copy link address". We

// don't validate this field in the frontend process.

///

/*--cef()--*/

virtual CefString GetUnfilteredLinkUrl() =0;

///

// Returns the source URL, if any, for the element that the context menu was

// invoked on. Example of elements with source URLs are img, audio, and video.

///

/*--cef()--*/

virtual CefString GetSourceUrl() =0;

///

// Returns true if the context menu was invoked on an image which has

// non-empty contents.

///

/*--cef()--*/

virtual bool HasImageContents() =0;

///

// Returns the title text or the alt text if the context menu was invoked on

// an image.

///

/*--cef()--*/

virtual CefString GetTitleText() = 0;

///

// Returns the URL of the top level page that the context menu was invoked on.

///

/*--cef()--*/

virtual CefString GetPageUrl() =0;

///

// Returns the URL of the subframe that the context menu was invoked on.

///

/*--cef()--*/

virtual CefString GetFrameUrl() =0;

///

// Returns the character encoding of the subframe that the context menu was

// invoked on.

///

/*--cef()--*/

virtual CefString GetFrameCharset() =0;

///

// Returns the type of context node that the context menu was invoked on.

///

/*--cef(default_retval=CM_MEDIATYPE_NONE)--*/

virtual MediaType GetMediaType() =0;

///

// Returns flags representing the actions supported by the media element, if

// any, that the context menu was invoked on.

///

/*--cef(default_retval=CM_MEDIAFLAG_NONE)--*/

virtual MediaStateFlags GetMediaStateFlags() =0;

///

// Returns the text of the selection, if any, that the context menu was

// invoked on.

///

/*--cef()--*/

virtual CefString GetSelectionText() =0;

///

// Returns the text of the misspelled word, if any, that the context menu was

// invoked on.

///

/*--cef()--*/

virtual CefString GetMisspelledWord() =0;

///

// Returns true if suggestions exist, false otherwise. Fills in |suggestions|

// from the spell check service for the misspelled word if there is one.

///

/*--cef()--*/

virtual bool GetDictionarySuggestions(std::vector<CefString>& suggestions) =0;

///

// Returns true if the context menu was invoked on an editable node.

///

/*--cef()--*/

virtual bool IsEditable() =0;

///

// Returns true if the context menu was invoked on an editable node where

// spell-check is enabled.

///

/*--cef()--*/

virtual bool IsSpellCheckEnabled() =0;

///

// Returns flags representing the actions supported by the editable node, if

// any, that the context menu was invoked on.

///

/*--cef(default_retval=CM_EDITFLAG_NONE)--*/

virtual EditStateFlags GetEditStateFlags() =0;

///

// Returns true if the context menu contains items specified by the renderer

// process (for example, plugin placeholder or pepper plugin menu items).

///

/*--cef()--*/

virtual bool IsCustomMenu() =0;

///

// Returns true if the context menu was invoked from a pepper plugin.

///

/*--cef()--*/

virtual bool IsPepperMenu() =0;

};

#endif // CEF_INCLUDE_CEF_CONTEXT_MENU_HANDLER_H_

cefpython/src/include/cef_context_menu_handler.h at cefpython56 · lineCode/cefpython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

cef_context_menu_handler.h

Latest commit

History

Breadcrumbs

cef_context_menu_handler.h

File metadata and controls