← Back to branch summary

~ubuntu-branches/ubuntu/vivid/ardour/vivid-proposed

« back to all changes in this revision

Viewing changes to libs/gtkmm2/atk/atkmm/image.h

  • Committer: Package Import Robot
  • Author(s): Felipe Sateler, Jaromír Mikeš, Felipe Sateler
  • Date: 2014-05-22 14:39:25 UTC
  • mfrom: (29 sid)
  • mto: This revision was merged to the branch mainline in revision 30.
  • Revision ID: package-import@ubuntu.com-20140522143925-vwqfo9287pmkrroe
Tags: 1:2.8.16+git20131003-3
* Team upload

[ Jaromír Mikeš ]
* Add -dbg package

[ Felipe Sateler ]
* Upload to experimental

Show diffs side-by-side

added added

removed removed

Lines of Context:
libs/gtkmm2/atk/atkmm/image.h
 
1
// -*- c++ -*-
 
2
// Generated by gtkmmproc -- DO NOT MODIFY!
 
3
#ifndef _ATKMM_IMAGE_H
 
4
#define _ATKMM_IMAGE_H
 
5
 
 
6
#include <glibmm.h>
 
7
 
 
8
/* $Id$ */
 
9
 
 
10
/* Copyright (C) 2002 The gtkmm Development Team
 
11
 *
 
12
 * This library is free software; you can redistribute it and/or
 
13
 * modify it under the terms of the GNU Library General Public
 
14
 * License as published by the Free Software Foundation; either
 
15
 * version 2 of the License, or (at your option) any later version.
 
16
 *
 
17
 * This library is distributed in the hope that it will be useful,
 
18
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
20
 * Library General Public License for more details.
 
21
 *
 
22
 * You should have received a copy of the GNU Library General Public
 
23
 * License along with this library; if not, write to the Free
 
24
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
25
 */
 
26
 
 
27
 
 
28
#include <atkmm/component.h> /* for Atk::CoordType */
 
29
 
 
30
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
31
extern "C"
 
32
{
 
33
  typedef struct _AtkImageIface AtkImageIface;
 
34
  typedef struct _AtkImage      AtkImage;
 
35
}
 
36
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
37
 
 
38
 
 
39
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
40
typedef struct _AtkImage AtkImage;
 
41
typedef struct _AtkImageClass AtkImageClass;
 
42
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
43
 
 
44
 
 
45
namespace Atk
 
46
{ class Image_Class; } // namespace Atk
 
47
namespace Atk
 
48
{
 
49
 
 
50
/** The ATK Interface implemented by components which expose image or pixmap content on-screen.
 
51
 * This should be implemented by Atk::Object subtypes on behalf of components which display image/pixmap information
 
52
 * onscreen, and which provide information (other than just widget borders, etc.) via that image content. For instance,
 
53
 * icons, buttons with icons, toolbar elements, and image viewing panes typically should implement AtkImage.
 
54
 *
 
55
 * Atk::Image primarily provides two types of information: coordinate information (useful for screen review mode of
 
56
 * screenreaders, and for use by onscreen magnifiers), and descriptive information. The descriptive information is
 
57
 * provided for alternative, text-only presentation of the most significant information present in the image. 
 
58
 */
 
59
 
 
60
class Image : public Glib::Interface
 
61
{
 
62
  
 
63
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
64
 
 
65
public:
 
66
  typedef Image CppObjectType;
 
67
  typedef Image_Class CppClassType;
 
68
  typedef AtkImage BaseObjectType;
 
69
  typedef AtkImageIface BaseClassType;
 
70
 
 
71
private:
 
72
  friend class Image_Class;
 
73
  static CppClassType image_class_;
 
74
 
 
75
  // noncopyable
 
76
  Image(const Image&);
 
77
  Image& operator=(const Image&);
 
78
 
 
79
protected:
 
80
  Image(); // you must derive from this class
 
81
  explicit Image(AtkImage* castitem);
 
82
 
 
83
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
84
 
 
85
public:
 
86
  virtual ~Image();
 
87
 
 
88
  static void add_interface(GType gtype_implementer);
 
89
 
 
90
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
91
  static GType get_type()      G_GNUC_CONST;
 
92
  static GType get_base_type() G_GNUC_CONST;
 
93
#endif
 
94
 
 
95
  ///Provides access to the underlying C GObject.
 
96
  AtkImage*       gobj()       { return reinterpret_cast<AtkImage*>(gobject_); }
 
97
 
 
98
  ///Provides access to the underlying C GObject.  
 
99
  const AtkImage* gobj() const { return reinterpret_cast<AtkImage*>(gobject_); }
 
100
 
 
101
private:
 
102
 
 
103
 
 
104
public:
 
105
  
 
106
  /** Sets the textual description for this image.
 
107
   * @param description A string description to set for @a image .
 
108
   * @return Boolean <tt>true</tt>, or <tt>false</tt> if operation could
 
109
   * not be completed.
 
110
   */
 
111
  bool set_image_description(const Glib::ustring& description);
 
112
  
 
113
  /** Get a textual description of this image.
 
114
   * @return A string representing the image description.
 
115
   */
 
116
  Glib::ustring get_image_description() const;
 
117
 
 
118
  
 
119
  /** Get the width and height in pixels for the specified image.
 
120
   * The values of @a width  and @a height  are returned as -1 if the
 
121
   * values cannot be obtained.
 
122
   * @param width Filled with the image width.
 
123
   * @param height Filled with the image height.
 
124
   */
 
125
  void get_image_size(int& width, int& height) const;
 
126
  
 
127
  /** Gets the position of the image in the form of a point specifying the
 
128
   * images top-left corner.  The values of @a x  and @a y  are returned as -1
 
129
   * if the values cannot be obtained.
 
130
   * @param x Address of <tt>int</tt> to put x coordinate position.
 
131
   * @param y Address of <tt>int</tt> to put y coordinate position.
 
132
   * @param coord_type Specifies whether the coordinates are relative to the screen
 
133
   * or to the components top level window.
 
134
   */
 
135
  void get_image_position(int& x, int& y, CoordType coord_type) const;
 
136
 
 
137
protected:
 
138
    virtual bool set_image_description_vfunc(const Glib::ustring& description);
 
139
    virtual const char* get_image_description_vfunc() const;
 
140
 
 
141
    virtual void get_image_position_vfunc(int& x, int& y, CoordType coord_type) const;
 
142
    virtual void get_image_size_vfunc(int& width, int& height) const;
 
143
 
 
144
 
 
145
public:
 
146
 
 
147
public:
 
148
  //C++ methods used to invoke GTK+ virtual functions:
 
149
 
 
150
protected:
 
151
  //GTK+ Virtual Functions (override these to change behaviour):
 
152
 
 
153
  //Default Signal Handlers::
 
154
 
 
155
 
 
156
};
 
157
 
 
158
} // namespace Atk
 
159
 
 
160
 
 
161
namespace Glib
 
162
{
 
163
  /** @relates Atk::Image
 
164
   * @param object The C instance
 
165
   * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
 
166
   * @result A C++ instance that wraps this C instance.
 
167
   */
 
168
  Glib::RefPtr<Atk::Image> wrap(AtkImage* object, bool take_copy = false);
 
169
 
 
170
} // namespace Glib
 
171
 
 
172
#endif /* _ATKMM_IMAGE_H */
 
173