OLD | NEW |
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 // This class assists you in dealing with a specific situation when managing | 5 // This class assists you in dealing with a specific situation when managing |
6 // ownership between a C++ object and a GTK widget. It is common to have a | 6 // ownership between a C++ object and a GTK widget. It is common to have a |
7 // C++ object which encapsulates a GtkWidget, and that widget is exposed from | 7 // C++ object which encapsulates a GtkWidget, and that widget is exposed from |
8 // the object for use outside of the class. In this situation, you commonly | 8 // the object for use outside of the class. In this situation, you commonly |
9 // want the GtkWidget's lifetime to match its C++ object's lifetime. Using an | 9 // want the GtkWidget's lifetime to match its C++ object's lifetime. Using an |
10 // OwnedWigetGtk will take ownership over the initial reference of the | 10 // OwnedWigetGtk will take ownership over the initial reference of the |
(...skipping 28 matching lines...) Expand all Loading... |
39 // was removed from a container, removing its only reference, it would be | 39 // was removed from a container, removing its only reference, it would be |
40 // destroyed (from the C++ object's perspective) unexpectedly destroyed. The | 40 // destroyed (from the C++ object's perspective) unexpectedly destroyed. The |
41 // solution is fairly simple, make sure that the C++ object owns the widget, | 41 // solution is fairly simple, make sure that the C++ object owns the widget, |
42 // and thus it is also responsible for destroying it. This boils down to: | 42 // and thus it is also responsible for destroying it. This boils down to: |
43 // GtkWidget* widget = gtk_widget_new(); | 43 // GtkWidget* widget = gtk_widget_new(); |
44 // g_object_ref_sink(widget); // Claim the initial floating reference. | 44 // g_object_ref_sink(widget); // Claim the initial floating reference. |
45 // ... | 45 // ... |
46 // gtk_destroy_widget(widget); // Ask all code to destroy their references. | 46 // gtk_destroy_widget(widget); // Ask all code to destroy their references. |
47 // g_object_unref(widget); // Destroy the initial reference we had claimed. | 47 // g_object_unref(widget); // Destroy the initial reference we had claimed. |
48 | 48 |
49 #ifndef CHROME_BROWSER_UI_GTK_OWNED_WIDGET_GTK_H_ | 49 #ifndef UI_BASE_GTK_OWNED_WIDGET_GTK_H_ |
50 #define CHROME_BROWSER_UI_GTK_OWNED_WIDGET_GTK_H_ | 50 #define UI_BASE_GTK_OWNED_WIDGET_GTK_H_ |
51 #pragma once | 51 #pragma once |
52 | 52 |
53 #include "base/basictypes.h" | 53 #include "base/basictypes.h" |
54 | 54 |
55 typedef struct _GtkWidget GtkWidget; | 55 typedef struct _GtkWidget GtkWidget; |
56 | 56 |
57 class OwnedWidgetGtk { | 57 class OwnedWidgetGtk { |
58 public: | 58 public: |
59 // Create an instance that isn't managing any ownership. | 59 // Create an instance that isn't managing any ownership. |
60 OwnedWidgetGtk() : widget_(NULL) { } | 60 OwnedWidgetGtk() : widget_(NULL) { } |
(...skipping 20 matching lines...) Expand all Loading... |
81 // that after gtk_widget_destroy we will be holding the only reference left | 81 // that after gtk_widget_destroy we will be holding the only reference left |
82 // on the object. We assert this in debug mode to help catch any leaks. | 82 // on the object. We assert this in debug mode to help catch any leaks. |
83 void Destroy(); | 83 void Destroy(); |
84 | 84 |
85 private: | 85 private: |
86 GtkWidget* widget_; | 86 GtkWidget* widget_; |
87 | 87 |
88 DISALLOW_COPY_AND_ASSIGN(OwnedWidgetGtk); | 88 DISALLOW_COPY_AND_ASSIGN(OwnedWidgetGtk); |
89 }; | 89 }; |
90 | 90 |
91 #endif // CHROME_BROWSER_UI_GTK_OWNED_WIDGET_GTK_H_ | 91 #endif // UI_BASE_GTK_OWNED_WIDGET_GTK_H_ |
OLD | NEW |