Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Side by Side Diff: include/AdblockPlus/FilterEngine.h

Issue 4978935175577600: Issue 1515 - Mention dynamic properties in the Filter and Subscription docs (Closed)
Patch Set: Created Oct. 30, 2014, 4:18 a.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « no previous file | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 /* 1 /*
2 * This file is part of Adblock Plus <http://adblockplus.org/>, 2 * This file is part of Adblock Plus <http://adblockplus.org/>,
3 * Copyright (C) 2006-2014 Eyeo GmbH 3 * Copyright (C) 2006-2014 Eyeo GmbH
4 * 4 *
5 * Adblock Plus is free software: you can redistribute it and/or modify 5 * Adblock Plus is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 3 as 6 * it under the terms of the GNU General Public License version 3 as
7 * published by the Free Software Foundation. 7 * published by the Free Software Foundation.
8 * 8 *
9 * Adblock Plus is distributed in the hope that it will be useful, 9 * Adblock Plus is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
(...skipping 15 matching lines...) Expand all
26 #include <AdblockPlus/JsValue.h> 26 #include <AdblockPlus/JsValue.h>
27 27
28 #include "tr1_memory.h" 28 #include "tr1_memory.h"
29 29
30 namespace AdblockPlus 30 namespace AdblockPlus
31 { 31 {
32 class FilterEngine; 32 class FilterEngine;
33 33
34 /** 34 /**
35 * Wrapper for an Adblock Plus filter object. 35 * Wrapper for an Adblock Plus filter object.
36 * There are no accessors for most
37 * [filter properties](https://adblockplus.org/jsdoc/adblockplus/symbols/Filte r.html),
38 * use `GetProperty()` to retrieve them by name.
36 */ 39 */
37 class Filter : public JsValue, 40 class Filter : public JsValue,
38 public std::tr1::enable_shared_from_this<Filter> 41 public std::tr1::enable_shared_from_this<Filter>
39 { 42 {
40 public: 43 public:
41 /** 44 /**
42 * Filter types, see https://adblockplus.org/en/filters. 45 * Filter types, see https://adblockplus.org/en/filters.
43 */ 46 */
44 enum Type {TYPE_BLOCKING, TYPE_EXCEPTION, 47 enum Type {TYPE_BLOCKING, TYPE_EXCEPTION,
45 TYPE_ELEMHIDE, TYPE_ELEMHIDE_EXCEPTION, 48 TYPE_ELEMHIDE, TYPE_ELEMHIDE_EXCEPTION,
(...skipping 27 matching lines...) Expand all
73 * Creates a wrapper for an existing JavaScript filter object. 76 * Creates a wrapper for an existing JavaScript filter object.
74 * Normally you shouldn't call this directly, but use 77 * Normally you shouldn't call this directly, but use
75 * FilterEngine::GetFilter() instead. 78 * FilterEngine::GetFilter() instead.
76 * @param value JavaScript filter object. 79 * @param value JavaScript filter object.
77 */ 80 */
78 Filter(JsValuePtr value); 81 Filter(JsValuePtr value);
79 }; 82 };
80 83
81 /** 84 /**
82 * Wrapper for a subscription object. 85 * Wrapper for a subscription object.
86 * There are no accessors for most
87 * [subscription properties](https://adblockplus.org/jsdoc/adblockplus/symbols /Subscription.html),
88 * use `GetProperty()` to retrieve them by name.
83 */ 89 */
84 class Subscription : public JsValue, 90 class Subscription : public JsValue,
85 public std::tr1::enable_shared_from_this<Subscription> 91 public std::tr1::enable_shared_from_this<Subscription>
86 { 92 {
87 public: 93 public:
88 /** 94 /**
89 * Checks if this subscription has been added to the list of subscriptions. 95 * Checks if this subscription has been added to the list of subscriptions.
90 * @return `true` if this subscription has been added. 96 * @return `true` if this subscription has been added.
91 */ 97 */
92 bool IsListed(); 98 bool IsListed();
(...skipping 275 matching lines...) Expand 10 before | Expand all | Expand 10 after
368 ContentType contentType, 374 ContentType contentType,
369 const std::string& documentUrl) const; 375 const std::string& documentUrl) const;
370 void UpdateAvailable(UpdateAvailableCallback callback, JsValueList& params); 376 void UpdateAvailable(UpdateAvailableCallback callback, JsValueList& params);
371 void UpdateCheckDone(const std::string& eventName, 377 void UpdateCheckDone(const std::string& eventName,
372 UpdateCheckDoneCallback callback, JsValueList& params); 378 UpdateCheckDoneCallback callback, JsValueList& params);
373 void FilterChanged(FilterChangeCallback callback, JsValueList& params); 379 void FilterChanged(FilterChangeCallback callback, JsValueList& params);
374 }; 380 };
375 } 381 }
376 382
377 #endif 383 #endif
OLDNEW
« no previous file with comments | « no previous file | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld