alecs/plasma-framework
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

a bit of Q_INVOCABLE to make qtscript happy

Browse Source 
svn path=/trunk/KDE/kdelibs/; revision=903258
This commit is contained in:
Marco Martin 2008-12-30 10:47:07 +00:00
parent 12fc12b692
commit d50b126504
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
framesvg.h
View File

@ -106,37 +106,37 @@ class PLASMA_EXPORT FrameSvg : public Svg
* Loads a new Svg * Loads a new Svg
* @arg imagePath the new file * @arg imagePath the new file
*/ */
void setImagePath(const QString &path); Q_INVOKABLE void setImagePath(const QString &path);
/** /**
* Sets what borders should be painted * Sets what borders should be painted
* @arg flags borders we want to paint * @arg flags borders we want to paint
*/ */
void setEnabledBorders(const EnabledBorders borders); Q_INVOKABLE void setEnabledBorders(const EnabledBorders borders);
/** /**
* Convenience method to get the enabled borders * Convenience method to get the enabled borders
* @return what borders are painted * @return what borders are painted
*/ */
EnabledBorders enabledBorders() const; Q_INVOKABLE EnabledBorders enabledBorders() const;
/** /**
* Resize the frame maintaining the same border size * Resize the frame maintaining the same border size
* @arg size the new size of the frame * @arg size the new size of the frame
*/ */
void resizeFrame(const QSizeF &size); Q_INVOKABLE void resizeFrame(const QSizeF &size);
/** /**
* @returns the size of the frame * @returns the size of the frame
*/ */
QSizeF frameSize() const; Q_INVOKABLE QSizeF frameSize() const;
/** /**
* Returns the margin size given the margin edge we want * Returns the margin size given the margin edge we want
* @arg edge the margin edge we want, top, bottom, left or right * @arg edge the margin edge we want, top, bottom, left or right
* @return the margin size * @return the margin size
*/ */
qreal marginSize(const Plasma::MarginEdge edge) const; Q_INVOKABLE qreal marginSize(const Plasma::MarginEdge edge) const;
/** /**
* Convenience method that extracts the size of the four margins * Convenience method that extracts the size of the four margins
@ -146,12 +146,12 @@ class PLASMA_EXPORT FrameSvg : public Svg
* @arg right right margin size * @arg right right margin size
* @arg bottom bottom margin size * @arg bottom bottom margin size
*/ */
void getMargins(qreal &left, qreal &top, qreal &right, qreal &bottom) const; Q_INVOKABLE void getMargins(qreal &left, qreal &top, qreal &right, qreal &bottom) const;
/** /**
* @return the rectangle of the center element, taking the margins into account. * @return the rectangle of the center element, taking the margins into account.
*/ */
QRectF contentsRect() const; Q_INVOKABLE QRectF contentsRect() const;
/** /**
* Sets the prefix (@see setElementPrefix) to 'north', 'south', 'west' and 'east' * Sets the prefix (@see setElementPrefix) to 'north', 'south', 'west' and 'east'
@ -159,7 +159,7 @@ class PLASMA_EXPORT FrameSvg : public Svg
* respectively. Clears the prefix in other cases. * respectively. Clears the prefix in other cases.
* @arg location location * @arg location location
*/ */
void setElementPrefix(Plasma::Location location); Q_INVOKABLE void setElementPrefix(Plasma::Location location);
/** /**
* Sets the prefix for the SVG elements to be used for painting. For example, * Sets the prefix for the SVG elements to be used for painting. For example,
@ -174,14 +174,14 @@ class PLASMA_EXPORT FrameSvg : public Svg
* If the * If the
* @arg prefix prefix for the SVG element names * @arg prefix prefix for the SVG element names
*/ */
void setElementPrefix(const QString & prefix); Q_INVOKABLE void setElementPrefix(const QString & prefix);
/** /**
* @return true if the svg has the necessary elements with the given prefix * @return true if the svg has the necessary elements with the given prefix
* to draw a frame * to draw a frame
* @arg prefix the given prefix we want to check if drawable * @arg prefix the given prefix we want to check if drawable
*/ */
bool hasElementPrefix(const QString & prefix) const; Q_INVOKABLE bool hasElementPrefix(const QString & prefix) const;
/** /**
* This is an overloaded method provided for convenience equivalent to * This is an overloaded method provided for convenience equivalent to
@ -191,37 +191,37 @@ class PLASMA_EXPORT FrameSvg : public Svg
* to draw a frame. * to draw a frame.
* @arg location the given prefix we want to check if drawable * @arg location the given prefix we want to check if drawable
*/ */
bool hasElementPrefix(Plasma::Location location) const; Q_INVOKABLE bool hasElementPrefix(Plasma::Location location) const;
/** /**
* Returns the prefix for SVG elements of the FrameSvg * Returns the prefix for SVG elements of the FrameSvg
* @return the prefix * @return the prefix
*/ */
QString prefix(); Q_INVOKABLE QString prefix();
/** /**
* Returns a mask that tightly contains the fully opaque areas of the svg * Returns a mask that tightly contains the fully opaque areas of the svg
* @return a region of opaque areas * @return a region of opaque areas
*/ */
QRegion mask() const; Q_INVOKABLE QRegion mask() const;
/** /**
* Sets whether saving all the rendered prefixes in a cache or not * Sets whether saving all the rendered prefixes in a cache or not
* @arg cache if use the cache or not * @arg cache if use the cache or not
*/ */
void setCacheAllRenderedFrames(bool cache); Q_INVOKABLE void setCacheAllRenderedFrames(bool cache);
/** /**
* @return if all the different prefixes should be kept in a cache when rendered * @return if all the different prefixes should be kept in a cache when rendered
*/ */
bool cacheAllRenderedFrames() const; Q_INVOKABLE bool cacheAllRenderedFrames() const;
/** /**
* Deletes the internal cache freeing memory: use this if you want to switch the rendered * Deletes the internal cache freeing memory: use this if you want to switch the rendered
* element and you don't plan to switch back to the previous one for a long time and you * element and you don't plan to switch back to the previous one for a long time and you
* used setUseCache(true) * used setUseCache(true)
*/ */
void clearCache(); Q_INVOKABLE void clearCache();
/** /**
* Returns a pixmap of the SVG represented by this object. * Returns a pixmap of the SVG represented by this object.