summaryrefslogtreecommitdiff
path: root/libs/gtkmm2/gtk/gtkmm/iconfactory.h
blob: 39b98e792f2e47815ae0b6d124afcf6f140d885c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _GTKMM_ICONFACTORY_H
#define _GTKMM_ICONFACTORY_H

#include <glibmm.h>

/* $Id$ */

/* Copyright (C) 1998-2002 The gtkmm Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */


#include <gtkmm/enums.h>
#include <gtkmm/object.h>
#include <gtkmm/enums.h>
#include <gtkmm/iconset.h>
#include <gtkmm/stockid.h>


#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GtkIconFactory GtkIconFactory;
typedef struct _GtkIconFactoryClass GtkIconFactoryClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */


namespace Gtk
{ class IconFactory_Class; } // namespace Gtk
namespace Gtk
{


class IconFactory : public Glib::Object
{
   
#ifndef DOXYGEN_SHOULD_SKIP_THIS

public:
  typedef IconFactory CppObjectType;
  typedef IconFactory_Class CppClassType;
  typedef GtkIconFactory BaseObjectType;
  typedef GtkIconFactoryClass BaseClassType;

private:  friend class IconFactory_Class;
  static CppClassType iconfactory_class_;

private:
  // noncopyable
  IconFactory(const IconFactory&);
  IconFactory& operator=(const IconFactory&);

protected:
  explicit IconFactory(const Glib::ConstructParams& construct_params);
  explicit IconFactory(GtkIconFactory* castitem);

#endif /* DOXYGEN_SHOULD_SKIP_THIS */

public:
  virtual ~IconFactory();

#ifndef DOXYGEN_SHOULD_SKIP_THIS
  static GType get_type()      G_GNUC_CONST;
  static GType get_base_type() G_GNUC_CONST;
#endif

  ///Provides access to the underlying C GObject.
  GtkIconFactory*       gobj()       { return reinterpret_cast<GtkIconFactory*>(gobject_); }

  ///Provides access to the underlying C GObject.
  const GtkIconFactory* gobj() const { return reinterpret_cast<GtkIconFactory*>(gobject_); }

  ///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
  GtkIconFactory* gobj_copy();

private:

   
protected:

  IconFactory();

public:
  
  static Glib::RefPtr<IconFactory> create();


  /** Adds the given @a icon_set  to the icon factory, under the name
   *  @a stock_id .  @a stock_id  should be namespaced for your application,
   * e.g. "myapp-whatever-icon".  Normally applications create a
   * Gtk::IconFactory, then add it to the list of default factories with
   * add_default(). Then they pass the @a stock_id  to
   * widgets such as Gtk::Image to display the icon. Themes can provide
   * an icon with the same name (such as "myapp-whatever-icon") to
   * override your application's default icons. If an icon already
   * existed in @a factory  for @a stock_id , it is unreferenced and replaced
   * with the new @a icon_set .
   * @param stock_id Icon name.
   * @param icon_set Icon set.
   */
  void add(const Gtk::StockID& stock_id, const IconSet& icon_set);
  
  /** Adds an icon factory to the list of icon factories searched by
   * Gtk::Style::lookup_icon_set(). This means that, for example,
   * Gtk::Image::new_from_stock() will be able to find icons in @a factory .
   * There will normally be an icon factory added for each library or
   * application that comes with icons. The default icon factories
   * can be overridden by themes.
   */
  void add_default();
  
  /** Removes an icon factory from the list of default icon
   * factories. Not normally used; you might use it for a library that
   * can be unloaded or shut down.
   */
  void remove_default();


public:

public:
  //C++ methods used to invoke GTK+ virtual functions:

protected:
  //GTK+ Virtual Functions (override these to change behaviour):

  //Default Signal Handlers::


};

} // namespace Gtk


namespace Glib
{
  /** @relates Gtk::IconFactory
   * @param object The C instance
   * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
   * @result A C++ instance that wraps this C instance.
   */
  Glib::RefPtr<Gtk::IconFactory> wrap(GtkIconFactory* object, bool take_copy = false);
}


#endif /* _GTKMM_ICONFACTORY_H */