← Back to branch summary

~ubuntu-dev/wxwidgets2.6/upstream-debian

« back to all changes in this revision

Viewing changes to docs/latex/wx/rendver.tex

  • Committer: Daniel T Chen
  • Date: 2006-06-26 10:15:11 UTC
  • Revision ID: crimsun@ubuntu.com-20060626101511-a4436cec4c6d9b35
Import Debian 2.6.3.2.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/latex/wx/rendver.tex
 
1
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
2
%% Name:        rendver.tex
 
3
%% Purpose:     wxRendererVersion documentation
 
4
%% Author:      Vadim Zeitlin
 
5
%% Modified by:
 
6
%% Created:     11.08.03
 
7
%% RCS-ID:      $Id: rendver.tex,v 1.4 2005/02/22 15:09:52 ABX Exp $
 
8
%% Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwindows.org>
 
9
%% License:     wxWindows license
 
10
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
11
 
 
12
\section{\class{wxRendererVersion}}\label{wxrendererversion}
 
13
 
 
14
This simple struct represents the \helpref{wxRendererNative}{wxrenderernative} 
 
15
interface version and is only used as the return value of 
 
16
\helpref{wxRendererNative::GetVersion}{wxrenderernativegetversion}.
 
17
 
 
18
The version has two components: the version itself and the age. If the main
 
19
program and the renderer have different versions they are never compatible with
 
20
each other because the version is only changed when an existing virtual
 
21
function is modified or removed. The age, on the other hand, is incremented
 
22
each time a new virtual method is added and so, at least for the compilers
 
23
using a common C++ object model, the calling program is compatible with any
 
24
renderer which has the age greater or equal to its age. This verification is
 
25
done by \helpref{IsCompatible}{wxrenderernativeiscompatible} method.
 
26
 
 
27
 
 
28
\wxheading{Derived from}
 
29
 
 
30
No base class
 
31
 
 
32
\wxheading{Include files}
 
33
 
 
34
<wx/renderer.h>
 
35
 
 
36
 
 
37
\latexignore{\rtfignore{\wxheading{Members}}}
 
38
 
 
39
\membersection{wxRendererVersion::IsCompatible}\label{wxrenderernativeiscompatible}
 
40
 
 
41
\func{static bool}{IsCompatible}{\param{const wxRendererVersion\& }{ver}}
 
42
 
 
43
Checks if the main program is compatible with the renderer having the version 
 
44
\arg{ver}, returns \true if it is and \false otherwise.
 
45
 
 
46
This method is used by 
 
47
\helpref{wxRendererNative::Load}{wxrenderernativeload} to determine whether a
 
48
renderer can be used.
 
49
 
 
50
 
 
51
\membersection{wxRendererVersion::version}\label{wxrendererversionversion}
 
52
 
 
53
\member{const int}{version}
 
54
 
 
55
The version component.
 
56
 
 
57
 
 
58
\membersection{wxRendererVersion::age}\label{wxrendererversionage}
 
59
 
 
60
\member{const int}{age}
 
61
 
 
62
The age component.
 
63