summaryrefslogtreecommitdiffstats
path: root/o3d/plugin/idl/canvas_paint.idl
diff options
context:
space:
mode:
authorgspencer@google.com <gspencer@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2009-05-27 23:15:42 +0000
committergspencer@google.com <gspencer@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2009-05-27 23:15:42 +0000
commit05b47f7a8c5451f858dc220df0e3a97542edace6 (patch)
treea2273d619f0625c9d44d40842845ccce2eac1045 /o3d/plugin/idl/canvas_paint.idl
parent5cdc8bdb4c847cefe7f4542bd10c9880c2c557a0 (diff)
downloadchromium_src-05b47f7a8c5451f858dc220df0e3a97542edace6.zip
chromium_src-05b47f7a8c5451f858dc220df0e3a97542edace6.tar.gz
chromium_src-05b47f7a8c5451f858dc220df0e3a97542edace6.tar.bz2
This is the O3D source tree's initial commit to the Chromium tree. It
is not built or referenced at all by the chrome build yet, and doesn't yet build in it's new home. We'll change that shortly. git-svn-id: svn://svn.chromium.org/chrome/trunk/src@17035 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'o3d/plugin/idl/canvas_paint.idl')
-rw-r--r--o3d/plugin/idl/canvas_paint.idl186
1 files changed, 186 insertions, 0 deletions
diff --git a/o3d/plugin/idl/canvas_paint.idl b/o3d/plugin/idl/canvas_paint.idl
new file mode 100644
index 0000000..94c3812
--- /dev/null
+++ b/o3d/plugin/idl/canvas_paint.idl
@@ -0,0 +1,186 @@
+/*
+ * Copyright 2009, Google Inc.
+ * All rights reserved.
+ *
+ * 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 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.
+ */
+
+
+namespace o3d {
+
+%[
+ CanvasFontMetrics is used to return values, measured in pixels, describing
+ the properties of a font used by the CanvasPaint objects. All the properties
+ of CanvasFontMetrics are read-only.
+%]
+
+[binding_model=by_value, nocpp, include="core/cross/canvas_paint.h"]
+class CanvasFontMetrics {
+ %[
+ The greatest distance above the baseline for any glyph (will be <= 0)
+ %]
+ [getter] float top_;
+
+ %[
+ The recommended distance above the baseline (will be <= 0)
+ %]
+ [getter] float ascent_;
+
+ %[
+ The recommended distance below the baseline (will be >= 0)
+ %]
+ [getter] float descent_;
+
+ %[
+ The greatest distance below the baseline for any glyph (will be >= 0)
+ %]
+ [getter] float bottom_;
+
+ %[
+ The recommended distance to add between lines of text (will be >= 0)
+ %]
+ [getter] float leading_;
+}; // CanvasFontMetrics
+
+
+%[
+ The CanvasPaint class is used for specifying how to draw objects and text to
+ a canvas.
+%]
+
+[nocpp, include="core/cross/canvas_paint.h"]
+class CanvasPaint : ParamObject {
+ %[
+ \var Style
+ \li NORMAL,
+ \li BOLD,
+ \li ITALIC,
+ \li BOLD_ITALIC
+ Text styles
+ %]
+ enum Style {
+ NORMAL,
+ BOLD,
+ ITALIC,
+ BOLD_ITALIC
+ };
+
+ %[
+ \var TextAlign
+ \li LEFT,
+ \li CENTER,
+ \li RIGHT,
+ Text alignment options
+ %]
+ enum TextAlign {
+ LEFT,
+ CENTER,
+ RIGHT
+ };
+
+ %[
+ Sets the color and radius of an outline around the text. Setting the
+ radius to 0 cancels the outline effect. The outline and shadow effects are
+ mutually exclusive.
+ \param radius Distance outward from object to draw the background
+ \param color Color of the outline
+ %]
+ void SetOutline(float radius, Float4 color);
+
+ %[
+ Create a blur shadow effect on this paint. Setting the radius to 0 cancels
+ the shadow effect.
+ \param radius radius to blur the paint
+ \param offset_y offset of the blur in X
+ \param offset_x offset of the blur in Y
+ \param color color for the blur
+ %]
+ void SetShadow(float radius,
+ float offset_x,
+ float offset_y,
+ Float4 color);
+
+ %[
+ Returns metrics describing the font currently set on this paint object.
+ %]
+ CanvasFontMetrics GetFontMetrics();
+
+ %[
+ Returns the bounds of the given text string when rendered with this paint.
+ The bounds are returned as an array containing [left, top, right, bottom]
+ values relative to (0, 0).
+ \param text The string of text to be measured.
+ %]
+ Float4 MeasureText(String text);
+
+ %[
+ The color used for all the draw operations using this paint.
+ %]
+ [getter, setter] Float4 color;
+
+ %[
+ The size of the font used for drawing text.
+ %]
+ [getter, setter] float text_size;
+
+ %[
+ The font typeface used for drawing text. Passing an empty string will
+ revert to the default font.
+ %]
+ [getter, setter] String text_typeface;
+
+ %[
+ The style applied to the text (e.g. italic, bold, etc)
+ %]
+ [getter, setter] Style text_style;
+
+ %[
+ The alignment mode used for drawing text.
+ %]
+ [getter, setter] TextAlign text_align;
+
+ %[
+ The 2D shader used by this paint. Set to null to stop using a shader.
+ %]
+ [getter, setter] CanvasShader? shader;
+
+ %[
+ Metrics of the current font used by the paint object.
+ %]
+ [userglue_getter, getter] CanvasFontMetrics font_metrics;
+
+ [verbatim=cpp_glue] %{
+ o3d::CanvasFontMetrics userglue_getter_font_metrics(
+ o3d::CanvasPaint* self) {
+ return self->GetFontMetrics();
+ }
+ %}
+
+}; // CanvasPaint
+
+} // namespace o3d
+