cheng/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

moving forward

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52052 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Stefan Csomor 2008-02-24 18:57:43 +00:00
parent 984daa2a57
commit 672fc8ada4
2 changed files with 67 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/doxygen/overviews/windowsizing.h
View File

@ -15,6 +15,7 @@
relate to each other, and how they interact with sizers. This document relate to each other, and how they interact with sizers. This document
will attempt to clear the fog a little, and give some simple will attempt to clear the fog a little, and give some simple
explanations of things. explanations of things.
@b BestSize: The best size of a widget depends on what kind of widget it @b BestSize: The best size of a widget depends on what kind of widget it
is, and usually also on the contents of the widget. For example a is, and usually also on the contents of the widget. For example a
#wxListBox's best size will be calculated based on #wxListBox's best size will be calculated based on
@ -29,11 +30,11 @@
such as #wxPanel, and works something like this: such as #wxPanel, and works something like this:
If the window has a sizer then it is used to calculate the best size. -# If the window has a sizer then it is used to calculate the best size.
Otherwise if the window has layout constraints then that is used to calculate the best size. -# Otherwise if the window has layout constraints then that is used to calculate the best size.
Otherwise if the window has children then the best size is set to be large enough to show all the children. -# Otherwise if the window has children then the best size is set to be large enough to show all the children.
Otherwise if there are no children then the window's min size will be used for the best size. -# Otherwise if there are no children then the window's min size will be used for the best size.
Otherwise if there is no min size set, then the current size is used for the best size. -# Otherwise if there is no min size set, then the current size is used for the best size.
@b MinSize: The min size of a widget is a size that is normally @b MinSize: The min size of a widget is a size that is normally
@ -43,15 +44,18 @@
non-default value is passed. Top-level windows such as non-default value is passed. Top-level windows such as
#wxFrame will not allow the user to resize the frame #wxFrame will not allow the user to resize the frame
below the min size. below the min size.
@b Size: The size of a widget can be explicitly set or fetched with @b Size: The size of a widget can be explicitly set or fetched with
the @c SetSize() or @c GetSize() methods. This size value the @c SetSize() or @c GetSize() methods. This size value
is the size that the widget is currently using on screen and is the is the size that the widget is currently using on screen and is the
way to change the size of something that is not being managed by a way to change the size of something that is not being managed by a
sizer. sizer.
@b ClientSize: The client size represents the widget's area inside @b ClientSize: The client size represents the widget's area inside
of any borders belonging to the widget and is the area that can be of any borders belonging to the widget and is the area that can be
drawn upon in a @c EVT_PAINT event. If a widget doesn't have a drawn upon in a @c EVT_PAINT event. If a widget doesn't have a
border then its client size is the same as its size. border then its client size is the same as its size.
@b InitialSize: The initial size of a widget is the size given to @b InitialSize: The initial size of a widget is the size given to
the constructor of the widget, if any. As mentioned above most the constructor of the widget, if any. As mentioned above most
controls will also set this size value as the control's min size. If controls will also set this size value as the control's min size. If
@ -60,6 +64,7 @@
@c wxSize(150,-1)) then most controls will fill in the missing @c wxSize(150,-1)) then most controls will fill in the missing
size components using the best size and will set the initial size of size components using the best size and will set the initial size of
the control to the resulting size. the control to the resulting size.
@b GetEffectiveMinSize(): (formerly @c GetBestFittingSize) A @b GetEffectiveMinSize(): (formerly @c GetBestFittingSize) A
blending of the widget's min size and best size, giving precedence to blending of the widget's min size and best size, giving precedence to
the min size. For example, if a widget's min size is set to (150, -1) the min size. For example, if a widget's min size is set to (150, -1)
@ -68,6 +73,7 @@
20). This method is what is called by the sizers when determining what 20). This method is what is called by the sizers when determining what
the requirements of each item in the sizer is, and is used for the requirements of each item in the sizer is, and is used for
calculating the overall minimum needs of the sizer. calculating the overall minimum needs of the sizer.
@b SetInitialSize(size): (formerly @c SetBestFittingSize) @b SetInitialSize(size): (formerly @c SetBestFittingSize)
This is a little different than the typical size setters. Rather than This is a little different than the typical size setters. Rather than
just setting an "initial size" attribute it actually sets the minsize just setting an "initial size" attribute it actually sets the minsize
@ -76,17 +82,21 @@
method to be a "Smart SetSize". This method is what is called by the method to be a "Smart SetSize". This method is what is called by the
constructor of most controls to set the minsize and initial size of constructor of most controls to set the minsize and initial size of
the control. the control.
@b window.Fit(): The @c Fit() method sets the size of a @b window.Fit(): The @c Fit() method sets the size of a
window to fit around its children. If it has no children then nothing window to fit around its children. If it has no children then nothing
is done, if it does have children then the size of the window is set is done, if it does have children then the size of the window is set
to the window's best size. to the window's best size.
@b sizer.Fit(window): This sets the size of the window to be large @b sizer.Fit(window): This sets the size of the window to be large
enough to accommodate the minimum size needed by the sizer, (along with enough to accommodate the minimum size needed by the sizer, (along with
a few other constraints...) If the sizer is the one that is assigned a few other constraints...) If the sizer is the one that is assigned
to the window then this should be equivalent to @c window.Fit(). to the window then this should be equivalent to @c window.Fit().
@b sizer.Layout(): Recalculates the minimum space needed by each @b sizer.Layout(): Recalculates the minimum space needed by each
item in the sizer, and then lays out the items within the space item in the sizer, and then lays out the items within the space
currently allotted to the sizer. currently allotted to the sizer.
@b window.Layout(): If the window has a sizer then it sets the @b window.Layout(): If the window has a sizer then it sets the
space given to the sizer to the current size of the window, which space given to the sizer to the current size of the window, which
results in a call to @c sizer.Layout(). If the window has layout results in a call to @c sizer.Layout(). If the window has layout

101
docs/doxygen/overviews/xrc.h
View File

@ -16,122 +16,122 @@
the application at run-time. XRC files can also be compiled into binary XRS files or C++ the application at run-time. XRC files can also be compiled into binary XRS files or C++
code (the former makes it possible to store all resources in a single file and the latter code (the former makes it possible to store all resources in a single file and the latter
is useful when you want to embed the resources into the executable). is useful when you want to embed the resources into the executable).
There are several advantages to using XRC resources. There are several advantages to using XRC resources.
@li Recompiling and linking an application is not necessary if the
Recompiling and linking an application is not necessary if the
resources change. resources change.
If you use a dialog designer that generates C++ code, it can be hard @li If you use a dialog designer that generates C++ code, it can be hard
to reintegrate this into existing C++ code. Separation of resources and code to reintegrate this into existing C++ code. Separation of resources and code
is a more elegant solution. is a more elegant solution.
You can choose between different alternative resource files at run time, if necessary. @li You can choose between different alternative resource files at run time, if necessary.
The XRC format uses sizers for flexibility, allowing dialogs to be resizable @li The XRC format uses sizers for flexibility, allowing dialogs to be resizable
and highly portable. and highly portable.
The XRC format is a wxWidgets standard, @li The XRC format is a wxWidgets standard,
and can be generated or postprocessed by any program that understands it. As it is based and can be generated or postprocessed by any program that understands it. As it is based
on the XML standard, existing XML editors can be used for simple editing purposes. on the XML standard, existing XML editors can be used for simple editing purposes.
XRC was written by Vaclav Slavik. XRC was written by Vaclav Slavik.
@ref xrcconcepts_overview @li @ref overview_xrcconcepts
@ref binaryresourcefiles_overview @li @ref overview_binaryresourcefiles
@ref embeddedresource_overview @li @ref overview_embeddedresource
@ref xrccppsample_overview @li @ref overview_xrccppsample
@ref xrcsample_overview @li @ref overview_xrcsample
@ref xrcfileformat_overview @li @ref overview_xrcfileformat
@ref xrccppheader_overview @li @ref overview_xrccppheader
@ref newresourcehandlers_overview @li @ref overview_newresourcehandlers
@section xrcconcepts XRC concepts @section overview_xrcconcepts XRC concepts
These are the typical steps for using XRC files in your application. These are the typical steps for using XRC files in your application.
Include the appropriate headers: normally "wx/xrc/xmlres.h" will suffice; @li Include the appropriate headers: normally "wx/xrc/xmlres.h" will suffice;
If you are going to use @ref binaryresourcefiles_overview, install @li If you are going to use @ref binaryresourcefiles_overview, install
wxFileSystem archive handler first with @c wxFileSystem::AddHandler(new wxArchiveFSHandler); wxFileSystem archive handler first with @c wxFileSystem::AddHandler(new wxArchiveFSHandler);
call @c wxXmlResource::Get()-InitAllHandlers() from your wxApp::OnInit function, @li call @c wxXmlResource::Get()-InitAllHandlers() from your wxApp::OnInit function,
and then call @c wxXmlResource::Get()-Load("myfile.xrc") to load the resource file; and then call @c wxXmlResource::Get()-Load("myfile.xrc") to load the resource file;
to create a dialog from a resource, create it using the default constructor, and then @li to create a dialog from a resource, create it using the default constructor, and then
load it using for example @c wxXmlResource::Get()-LoadDialog(dlg, this, "dlg1"); load it using for example @c wxXmlResource::Get()-LoadDialog(dlg, this, "dlg1");
set up event tables as usual but use the @c XRCID(str) macro to translate from XRC string names @li set up event tables as usual but use the @c XRCID(str) macro to translate from XRC string names
to a suitable integer identifier, for example @c EVT_MENU(XRCID("quit"), MyFrame::OnQuit). to a suitable integer identifier, for example @c EVT_MENU(XRCID("quit"), MyFrame::OnQuit).
To create an XRC file, you can use one of the following methods. To create an XRC file, you can use one of the following methods.
@li Create the file by hand;
Create the file by hand; @li use #wxDesigner, a commercial dialog designer/RAD tool;
use #wxDesigner, a commercial dialog designer/RAD tool; @li use #DialogBlocks, a commercial dialog editor;
use #DialogBlocks, a commercial dialog editor; @li use #XRCed, a wxPython-based
use #XRCed, a wxPython-based
dialog editor that you can find in the @c wxPython/tools subdirectory of the wxWidgets dialog editor that you can find in the @c wxPython/tools subdirectory of the wxWidgets
CVS archive; CVS archive;
use #wxGlade, a GUI designer written in wxPython. At the moment it can generate Python, C++ and XRC; @li use #wxGlade, a GUI designer written in wxPython. At the moment it can generate Python, C++ and XRC;
A complete list of third-party tools that write to XRC can be found at #www.wxwidgets.org/lnk_tool.htm. A complete list of third-party tools that write to XRC can be found at #www.wxwidgets.org/lnk_tool.htm.
It is highly recommended that you use a resource editing tool, since it's fiddly writing It is highly recommended that you use a resource editing tool, since it's fiddly writing
XRC files by hand. XRC files by hand.
You can use wxXmlResource::Load in a number of ways. You can use wxXmlResource::Load in a number of ways.
You can pass an XRC file (XML-based text resource file) You can pass an XRC file (XML-based text resource file)
or a @ref binaryresourcefiles_overview (extension ZIP or XRS) containing other XRC. or a @ref binaryresourcefiles_overview (extension ZIP or XRS) containing other XRC.
You can also use @ref embeddedresource_overview You can also use @ref embeddedresource_overview
@section binaryresourcefiles Using binary resource files @section overview_binaryresourcefiles Using binary resource files
To compile binary resource files, use the command-line wxrc utility. It takes one or more file parameters To compile binary resource files, use the command-line wxrc utility. It takes one or more file parameters
(the input XRC files) and the following switches and options: (the input XRC files) and the following switches and options:
@li -h (--help): show a help message
-h (--help): show a help message @li -v (--verbose): show verbose logging information
-v (--verbose): show verbose logging information @li -c (--cpp-code): write C++ source rather than a XRS file
-c (--cpp-code): write C++ source rather than a XRS file @li -e (--extra-cpp-code): if used together with -c, generates C++ header file
-e (--extra-cpp-code): if used together with -c, generates C++ header file
containing class definitions for the windows defined by the XRC file (see special subsection) containing class definitions for the windows defined by the XRC file (see special subsection)
-u (--uncompressed): do not compress XML files (C++ only) @li -u (--uncompressed): do not compress XML files (C++ only)
-g (--gettext): output underscore-wrapped strings that poEdit or gettext can scan. Outputs to stdout, or a file if -o is used @li -g (--gettext): output underscore-wrapped strings that poEdit or gettext can scan. Outputs to stdout, or a file if -o is used
-n (--function) name: specify C++ function name (use with -c) @li -n (--function) name: specify C++ function name (use with -c)
-o (--output) filename: specify the output file, such as resource.xrs or resource.cpp @li -o (--output) filename: specify the output file, such as resource.xrs or resource.cpp
-l (--list-of-handlers) filename: output a list of necessary handlers to this file @li -l (--list-of-handlers) filename: output a list of necessary handlers to this file
For example: For example:
@code @code
% wxrc resource.xrc % wxrc resource.xrc
% wxrc resource.xrc -o resource.xrs % wxrc resource.xrc -o resource.xrs
% wxrc resource.xrc -v -c -o resource.cpp % wxrc resource.xrc -v -c -o resource.cpp
@endcode @endcode
@b Note @note
XRS file is essentially a renamed ZIP archive which means that you can manipulate XRS file is essentially a renamed ZIP archive which means that you can manipulate
it with standard ZIP tools. Note that if you are using XRS files, you have it with standard ZIP tools. Note that if you are using XRS files, you have
to initialize the #wxFileSystem archive handler first! It is a simple to initialize the #wxFileSystem archive handler first! It is a simple
thing to do: thing to do:
@code @code
#include wx/filesys.h #include wx/filesys.h
#include wx/fs_arc.h #include wx/fs_arc.h
... ...
wxFileSystem::AddHandler(new wxArchiveFSHandler); wxFileSystem::AddHandler(new wxArchiveFSHandler);
@endcode @endcode
@section embeddedresource Using embedded resources @section overview_embeddedresource Using embedded resources
It is sometimes useful to embed resources in the executable itself instead It is sometimes useful to embed resources in the executable itself instead
of loading an external file (e.g. when your app is small and consists only of one of loading an external file (e.g. when your app is small and consists only of one
exe file). XRC provides means to convert resources into regular C++ file that exe file). XRC provides means to convert resources into regular C++ file that
can be compiled and included in the executable. can be compiled and included in the executable.
Use the @c -c switch to Use the @c -c switch to
@c wxrc utility to produce C++ file with embedded resources. This file will @c wxrc utility to produce C++ file with embedded resources. This file will
contain a function called @e InitXmlResource (unless you override this with contain a function called @e InitXmlResource (unless you override this with
a command line switch). Use it to load the resource: a command line switch). Use it to load the resource:
@code @code
extern void InitXmlResource(); // defined in generated file extern void InitXmlResource(); // defined in generated file
... ...
wxXmlResource::Get()-InitAllHandlers(); wxXmlResource::Get()-InitAllHandlers();
InitXmlResource(); InitXmlResource();
@ -139,7 +139,7 @@
@endcode @endcode
@section xrccppsample XRC C++ sample @section overview_xrccppsample XRC C++ sample
This is the C++ source file (xrcdemo.cpp) for the XRC sample. This is the C++ source file (xrcdemo.cpp) for the XRC sample.
@ -264,7 +264,7 @@
@endcode @endcode
@section xrcsample XRC resource file sample @section overview_xrcsample XRC resource file sample
This is the XML file (resource.xrc) for the XRC sample. This is the XML file (resource.xrc) for the XRC sample.
@ -426,12 +426,12 @@
@endcode @endcode
@section xrcfileformat XRC file format @section overview_xrcfileformat XRC file format
Please see Technical Note 14 (docs/tech/tn0014.txt) in your wxWidgets Please see Technical Note 14 (docs/tech/tn0014.txt) in your wxWidgets
distribution. distribution.
@section xrccppheader C++ header file generation @section overview_xrccppheader C++ header file generation
Using the @c -e switch together with @c -c, a C++ header file is written Using the @c -e switch together with @c -c, a C++ header file is written
containing class definitions for the GUI windows defined in the XRC file. containing class definitions for the GUI windows defined in the XRC file.
@ -439,10 +439,12 @@
development. development.
The classes can be used as basis for development, freeing the The classes can be used as basis for development, freeing the
programmer from dealing with most of the XRC specifics (e.g. @c XRCCTRL). programmer from dealing with most of the XRC specifics (e.g. @c XRCCTRL).
For each top level window defined in the XRC file a C++ class definition is For each top level window defined in the XRC file a C++ class definition is
generated, containing as class members the named widgets of the window. generated, containing as class members the named widgets of the window.
A default constructor for each class is also generated. Inside the constructor A default constructor for each class is also generated. Inside the constructor
all XRC loading is done and all class members representing widgets are initialized. all XRC loading is done and all class members representing widgets are initialized.
A simple example will help understand how the scheme works. Suppose you have A simple example will help understand how the scheme works. Suppose you have
a XRC file defining a top level window @c TestWnd_Base, which subclasses @c wxFrame (any a XRC file defining a top level window @c TestWnd_Base, which subclasses @c wxFrame (any
other class like @c wxDialog will do also), and has subwidgets @c wxTextCtrl A and @c wxButton B. other class like @c wxDialog will do also), and has subwidgets @c wxTextCtrl A and @c wxButton B.
@ -535,11 +537,12 @@
@endcode @endcode
@section newresourcehandlers Adding new resource handlers @section overview_newresourcehandlers Adding new resource handlers
Adding a new resource handler is pretty easy. Adding a new resource handler is pretty easy.
Typically, to add an handler for the @c MyControl class, you'll want to create Typically, to add an handler for the @c MyControl class, you'll want to create
the @c xh_mycontrol.h @c xh_mycontrol.cpp files. the @c xh_mycontrol.h @c xh_mycontrol.cpp files.
The header needs to contains the @c MyControlXmlHandler class definition: The header needs to contains the @c MyControlXmlHandler class definition:
@code @code